Artifact 4f2f594a410ce3976071a008a4d6cd0e41f16968:
File
www/faq.wiki
part of check-in
[627de3bf16]
- Documentation updates: Added FAQ and testimonials.
by
drh on
2009-01-25 21:16:55.
0000: 3c 68 31 20 61 6c 69 67 6e 3d 22 63 65 6e 74 65 <h1 align="cente
0010: 72 22 3e 46 72 65 71 75 65 6e 74 6c 79 20 41 73 r">Frequently As
0020: 6b 65 64 20 51 75 65 73 74 69 6f 6e 73 3c 2f 68 ked Questions</h
0030: 31 3e 0a 0a 3c 70 3e 4e 6f 74 65 3a 20 53 65 65 1>..<p>Note: See
0040: 20 61 6c 73 6f 20 3c 61 20 68 72 65 66 3d 22 71 also <a href="q
0050: 61 6e 64 63 2e 77 69 6b 69 22 3e 51 75 65 73 74 andc.wiki">Quest
0060: 69 6f 6e 73 20 61 6e 64 20 43 72 69 74 69 63 69 ions and Critici
0070: 73 6d 73 3c 2f 61 3e 2e 0a 0a 3c 6f 6c 3e 0a 3c sms</a>...<ol>.<
0080: 6c 69 3e 3c 61 20 68 72 65 66 3d 22 23 71 31 22 li><a href="#q1"
0090: 3e 57 68 61 74 20 47 55 49 73 20 61 72 65 20 61 >What GUIs are a
00a0: 76 61 69 6c 61 62 6c 65 20 66 6f 72 20 66 6f 73 vailable for fos
00b0: 73 69 6c 3f 3c 2f 61 3e 3c 2f 6c 69 3e 0a 3c 6c sil?</a></li>.<l
00c0: 69 3e 3c 61 20 68 72 65 66 3d 22 23 71 32 22 3e i><a href="#q2">
00d0: 57 68 61 74 20 69 73 20 74 68 65 20 64 69 66 66 What is the diff
00e0: 65 72 65 6e 63 65 20 62 65 74 77 65 65 6e 20 61 erence between a
00f0: 20 22 62 72 61 6e 63 68 22 20 61 6e 64 20 61 20 "branch" and a
0100: 22 66 6f 72 6b 22 3f 3c 2f 61 3e 3c 2f 6c 69 3e "fork"?</a></li>
0110: 0a 3c 6c 69 3e 3c 61 20 68 72 65 66 3d 22 23 71 .<li><a href="#q
0120: 33 22 3e 48 6f 77 20 64 6f 20 49 20 63 72 65 61 3">How do I crea
0130: 74 65 20 61 20 6e 65 77 20 62 72 61 6e 63 68 20 te a new branch
0140: 69 6e 20 66 6f 73 73 69 6c 3f 3c 2f 61 3e 3c 2f in fossil?</a></
0150: 6c 69 3e 0a 3c 6c 69 3e 3c 61 20 68 72 65 66 3d li>.<li><a href=
0160: 22 23 71 34 22 3e 48 6f 77 20 64 6f 20 49 20 63 "#q4">How do I c
0170: 72 65 61 74 65 20 61 20 70 72 69 76 61 74 65 20 reate a private
0180: 62 72 61 6e 63 68 20 74 68 61 74 20 77 6f 6e 27 branch that won'
0190: 74 20 67 65 74 20 70 75 73 68 65 64 20 62 61 63 t get pushed bac
01a0: 6b 20 74 6f 20 74 68 65 0a 20 20 6d 61 69 6e 20 k to the. main
01b0: 72 65 70 6f 73 69 74 6f 72 79 2e 3c 2f 61 3e 3c repository.</a><
01c0: 2f 6c 69 3e 0a 3c 2f 6f 6c 3e 0a 3c 68 72 3e 0a /li>.</ol>.<hr>.
01d0: 3c 61 20 6e 61 6d 65 3d 22 71 31 22 3e 3c 2f 61 <a name="q1"></a
01e0: 3e 0a 3c 70 3e 3c 62 3e 28 31 29 20 57 68 61 74 >.<p><b>(1) What
01f0: 20 47 55 49 73 20 61 72 65 20 61 76 61 69 6c 61 GUIs are availa
0200: 62 6c 65 20 66 6f 72 20 66 6f 73 73 69 6c 3f 3c ble for fossil?<
0210: 2f 62 3e 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 6b 71 /b></p>..<blockq
0220: 75 6f 74 65 3e 54 68 65 20 66 6f 73 73 69 6c 20 uote>The fossil
0230: 65 78 65 63 75 74 61 62 6c 65 20 63 6f 6d 65 73 executable comes
0240: 20 77 69 74 68 20 61 20 77 65 62 2d 62 61 73 65 with a web-base
0250: 64 20 47 55 49 20 62 75 69 6c 74 20 69 6e 2e 20 d GUI built in.
0260: 20 4a 75 73 74 20 72 75 6e 3a 0a 0a 3c 62 6c 6f Just run:..<blo
0270: 63 6b 71 75 6f 74 65 3e 0a 3c 62 3e 66 6f 73 73 ckquote>.<b>foss
0280: 69 6c 20 75 69 3c 2f 62 3e 20 3c 69 3e 52 45 50 il ui</b> <i>REP
0290: 4f 53 49 54 4f 52 59 2d 46 49 4c 45 4e 41 4d 45 OSITORY-FILENAME
02a0: 3c 2f 69 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 </i>.</blockquot
02b0: 65 3e 0a 0a 41 6e 64 20 79 6f 75 72 20 64 65 66 e>..And your def
02c0: 61 75 6c 74 20 77 65 62 20 62 72 6f 77 73 65 72 ault web browser
02d0: 20 73 68 6f 75 6c 64 20 70 6f 70 20 75 70 20 61 should pop up a
02e0: 6e 64 20 61 75 74 6f 6d 61 74 69 63 61 6c 6c 79 nd automatically
02f0: 20 70 6f 69 6e 74 20 74 6f 0a 74 68 65 20 66 6f point to.the fo
0300: 73 73 69 6c 20 69 6e 74 65 72 66 61 63 65 2e 20 ssil interface.
0310: 20 28 48 69 6e 74 3a 20 20 59 6f 75 20 63 61 6e (Hint: You can
0320: 20 6f 6d 69 74 20 74 68 65 20 3c 69 3e 52 45 50 omit the <i>REP
0330: 4f 53 49 54 4f 52 59 2d 46 49 4c 45 4e 41 4d 45 OSITORY-FILENAME
0340: 3c 2f 69 3e 0a 69 66 20 79 6f 75 20 61 72 65 20 </i>.if you are
0350: 77 69 74 68 69 6e 20 61 6e 20 6f 70 65 6e 20 63 within an open c
0360: 68 65 63 6b 2d 6f 75 74 2e 29 3c 2f 62 6c 6f 63 heck-out.)</bloc
0370: 6b 71 75 6f 74 65 3e 3c 2f 6c 69 3e 0a 0a 3c 61 kquote></li>..<a
0380: 20 6e 61 6d 65 3d 22 71 32 22 3e 3c 2f 61 3e 0a name="q2"></a>.
0390: 3c 70 3e 3c 62 3e 28 32 29 20 57 68 61 74 20 69 <p><b>(2) What i
03a0: 73 20 74 68 65 20 64 69 66 66 65 72 65 6e 63 65 s the difference
03b0: 20 62 65 74 77 65 65 6e 20 61 20 22 62 72 61 6e between a "bran
03c0: 63 68 22 20 61 6e 64 20 61 20 22 66 6f 72 6b 22 ch" and a "fork"
03d0: 3f 3c 2f 62 3e 3c 2f 70 3e 0a 0a 3c 62 6c 6f 63 ?</b></p>..<bloc
03e0: 6b 71 75 6f 74 65 3e 54 68 69 73 20 69 73 20 61 kquote>This is a
03f0: 20 62 69 67 20 71 75 65 73 74 69 6f 6e 20 2d 20 big question -
0400: 74 6f 6f 20 62 69 67 20 74 6f 20 61 6e 73 77 65 too big to answe
0410: 72 20 69 6e 20 61 20 46 41 51 2e 20 20 50 6c 65 r in a FAQ. Ple
0420: 61 73 65 0a 72 65 61 64 20 74 68 65 20 3c 61 20 ase.read the <a
0430: 68 72 65 66 3d 22 62 72 61 6e 63 68 69 6e 67 2e href="branching.
0440: 77 69 6b 69 22 3e 42 72 61 6e 63 68 69 6e 67 2c wiki">Branching,
0450: 20 46 6f 72 6b 69 6e 67 2c 20 4d 65 72 67 69 6e Forking, Mergin
0460: 67 2c 0a 61 6e 64 20 54 61 67 67 69 6e 67 3c 2f g,.and Tagging</
0470: 61 3e 20 64 6f 63 75 6d 65 6e 74 2e 3c 2f 62 6c a> document.</bl
0480: 6f 63 6b 71 75 6f 74 65 3e 3c 2f 6c 69 3e 0a 0a ockquote></li>..
0490: 3c 61 20 6e 61 6d 65 3d 22 71 33 22 3e 3c 2f 61 <a name="q3"></a
04a0: 3e 0a 3c 70 3e 3c 62 3e 28 33 29 20 48 6f 77 20 >.<p><b>(3) How
04b0: 64 6f 20 49 20 63 72 65 61 74 65 20 61 20 6e 65 do I create a ne
04c0: 77 20 62 72 61 6e 63 68 20 69 6e 20 66 6f 73 73 w branch in foss
04d0: 69 6c 3f 3c 2f 62 3e 3c 2f 70 3e 0a 0a 3c 62 6c il?</b></p>..<bl
04e0: 6f 63 6b 71 75 6f 74 65 3e 54 68 65 72 65 20 61 ockquote>There a
04f0: 72 65 20 6c 6f 74 73 20 6f 66 20 77 61 79 73 3a re lots of ways:
0500: 0a 0a 57 68 65 6e 20 79 6f 75 20 61 72 65 20 63 ..When you are c
0510: 68 65 63 6b 69 6e 67 20 69 6e 20 61 20 6e 65 77 hecking in a new
0520: 20 63 68 61 6e 67 65 20 75 73 69 6e 67 20 74 68 change using th
0530: 65 20 3c 62 3e 63 6f 6d 6d 69 74 3c 2f 62 3e 0a e <b>commit</b>.
0540: 63 6f 6d 6d 61 6e 64 2c 20 79 6f 75 20 63 61 6e command, you can
0550: 20 61 64 64 20 74 68 65 20 6f 70 74 69 6f 6e 20 add the option
0560: 20 22 2d 2d 62 72 61 6e 63 68 20 3c 69 3e 42 52 "--branch <i>BR
0570: 41 4e 43 48 2d 4e 41 4d 45 3c 2f 69 3e 22 20 74 ANCH-NAME</i>" t
0580: 6f 0a 6d 61 6b 65 20 74 68 65 20 63 68 61 6e 67 o.make the chang
0590: 65 20 62 65 20 74 68 65 20 66 6f 75 6e 64 69 6e e be the foundin
05a0: 67 20 63 68 65 63 6b 2d 69 6e 20 66 6f 72 20 61 g check-in for a
05b0: 20 6e 65 77 20 62 72 61 6e 63 68 2e 20 20 59 6f new branch. Yo
05c0: 75 20 63 61 6e 0a 61 6c 73 6f 20 61 64 64 20 74 u can.also add t
05d0: 68 65 20 22 2d 2d 62 67 63 6f 6c 6f 72 20 3c 69 he "--bgcolor <i
05e0: 3e 43 4f 4c 4f 52 3c 2f 69 3e 22 20 6f 70 74 69 >COLOR</i>" opti
05f0: 6f 6e 20 74 6f 20 67 69 76 65 20 74 68 65 20 62 on to give the b
0600: 72 61 6e 63 68 20 61 0a 73 70 65 63 69 66 69 63 ranch a.specific
0610: 20 62 61 63 6b 67 72 6f 75 6e 64 20 63 6f 6c 6f background colo
0620: 72 20 6f 6e 20 74 69 6d 65 6c 69 6e 65 73 2e 0a r on timelines..
0630: 0a 49 66 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 .If you want to
0640: 63 72 65 61 74 65 20 61 20 6e 65 77 20 62 72 61 create a new bra
0650: 6e 63 68 20 77 68 6f 73 65 20 66 6f 75 6e 64 69 nch whose foundi
0660: 6e 67 20 63 68 65 63 6b 2d 69 6e 20 69 73 20 74 ng check-in is t
0670: 68 65 0a 73 61 6d 65 20 61 73 20 61 6e 20 65 78 he.same as an ex
0680: 69 73 74 69 6e 67 20 63 68 65 63 6b 2d 69 6e 2c isting check-in,
0690: 20 75 73 65 20 74 68 69 73 20 63 6f 6d 6d 61 6e use this comman
06a0: 64 3a 0a 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e d:..<blockquote>
06b0: 0a 3c 62 3e 66 6f 73 73 69 6c 20 62 72 61 6e 63 .<b>fossil branc
06c0: 68 20 6e 65 77 3c 2f 62 3e 20 3c 69 3e 42 52 41 h new</b> <i>BRA
06d0: 4e 43 48 2d 4e 41 4d 45 20 42 41 53 49 53 3c 2f NCH-NAME BASIS</
06e0: 69 3e 0a 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e i>.</blockquote>
06f0: 0a 0a 54 68 65 20 3c 69 3e 42 52 41 4e 43 48 2d ..The <i>BRANCH-
0700: 4e 41 4d 45 3c 2f 69 3e 20 61 72 67 75 6d 65 6e NAME</i> argumen
0710: 74 20 69 73 20 74 68 65 20 6e 61 6d 65 20 6f 66 t is the name of
0720: 20 74 68 65 20 6e 65 77 20 62 72 61 6e 63 68 20 the new branch
0730: 61 6e 64 20 74 68 65 0a 3c 69 3e 42 41 53 49 53 and the.<i>BASIS
0740: 3c 2f 69 3e 20 61 72 67 75 6d 65 6e 74 20 69 73 </i> argument is
0750: 20 74 68 65 20 6e 61 6d 65 20 6f 66 20 74 68 65 the name of the
0760: 20 63 68 65 63 6b 2d 69 6e 20 74 68 61 74 20 74 check-in that t
0770: 68 65 20 62 72 61 6e 63 68 20 73 70 6c 69 74 73 he branch splits
0780: 0a 6f 66 66 20 66 72 6f 6d 2e 0a 0a 49 66 20 79 .off from...If y
0790: 6f 75 20 61 6c 72 65 61 64 79 20 68 61 76 65 20 ou already have
07a0: 61 20 66 6f 72 6b 20 69 6e 20 79 6f 75 72 20 63 a fork in your c
07b0: 68 65 63 6b 2d 69 6e 20 74 72 65 65 20 61 6e 64 heck-in tree and
07c0: 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 63 6f 6e you want to con
07d0: 76 65 72 74 0a 74 68 61 74 20 66 6f 72 6b 20 74 vert.that fork t
07e0: 6f 20 61 20 62 72 61 6e 63 68 2c 20 79 6f 75 20 o a branch, you
07f0: 63 61 6e 20 64 6f 20 74 68 69 73 20 66 72 6f 6d can do this from
0800: 20 74 68 65 20 77 65 62 20 69 6e 74 65 72 66 61 the web interfa
0810: 63 65 2e 0a 46 69 72 73 74 20 6c 6f 63 61 74 65 ce..First locate
0820: 20 74 68 65 20 63 68 65 63 6b 2d 69 6e 20 74 68 the check-in th
0830: 61 74 20 79 6f 75 20 77 61 6e 74 20 74 6f 20 62 at you want to b
0840: 65 0a 74 68 65 20 66 6f 75 6e 64 69 6e 67 20 63 e.the founding c
0850: 68 65 63 6b 2d 69 6e 20 6f 66 20 79 6f 75 72 20 heck-in of your
0860: 62 72 61 6e 63 68 20 6f 6e 20 74 68 65 20 74 69 branch on the ti
0870: 6d 65 6c 69 6e 65 20 61 6e 64 20 63 6c 69 63 6b meline and click
0880: 20 6f 6e 20 69 74 73 0a 6c 69 6e 6b 20 73 6f 20 on its.link so
0890: 74 68 61 74 20 79 6f 75 20 61 72 65 20 6f 6e 20 that you are on
08a0: 74 68 65 20 3c 62 3e 63 69 3c 2f 62 3e 20 70 61 the <b>ci</b> pa
08b0: 67 65 2e 20 20 54 68 65 6e 20 66 69 6e 64 20 74 ge. Then find t
08c0: 68 65 20 22 3c 62 3e 65 64 69 74 3c 2f 62 3e 22 he "<b>edit</b>"
08d0: 0a 6c 69 6e 6b 20 28 6e 65 61 72 20 74 68 65 20 .link (near the
08e0: 22 43 6f 6d 6d 61 6e 64 73 3a 22 20 6c 61 62 65 "Commands:" labe
08f0: 6c 29 20 61 6e 64 20 63 6c 69 63 6b 20 6f 6e 20 l) and click on
0900: 74 68 61 74 2e 20 20 4f 6e 20 74 68 65 20 0a 22 that. On the ."
0910: 45 64 69 74 20 43 68 65 63 6b 2d 69 6e 22 20 70 Edit Check-in" p
0920: 61 67 65 2c 20 63 68 65 63 6b 20 74 68 65 20 62 age, check the b
0930: 6f 78 20 62 65 73 69 64 65 20 22 42 72 61 6e 63 ox beside "Branc
0940: 68 69 6e 67 3a 22 20 61 6e 64 20 66 69 6c 6c 20 hing:" and fill
0950: 69 6e 20 0a 74 68 65 20 6e 61 6d 65 20 6f 66 20 in .the name of
0960: 79 6f 75 72 20 6e 65 77 20 62 72 61 6e 63 68 20 your new branch
0970: 74 6f 20 74 68 65 20 72 69 67 68 74 20 61 6e 64 to the right and
0980: 20 70 72 65 73 73 20 74 68 65 20 22 41 70 70 6c press the "Appl
0990: 79 20 43 68 61 6e 67 65 73 22 0a 62 75 74 74 6f y Changes".butto
09a0: 6e 2e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 65 3e 3c n.</blockquote><
09b0: 2f 6c 69 3e 0a 0a 3c 61 20 6e 61 6d 65 3d 22 71 /li>..<a name="q
09c0: 34 22 3e 3c 2f 61 3e 0a 3c 70 3e 3c 62 3e 28 34 4"></a>.<p><b>(4
09d0: 29 20 48 6f 77 20 64 6f 20 49 20 63 72 65 61 74 ) How do I creat
09e0: 65 20 61 20 70 72 69 76 61 74 65 20 62 72 61 6e e a private bran
09f0: 63 68 20 74 68 61 74 20 77 6f 6e 27 74 20 67 65 ch that won't ge
0a00: 74 20 70 75 73 68 65 64 20 62 61 63 6b 20 74 6f t pushed back to
0a10: 20 74 68 65 0a 20 20 6d 61 69 6e 20 72 65 70 6f the. main repo
0a20: 73 69 74 6f 72 79 2e 3c 2f 62 3e 3c 2f 70 3e 0a sitory.</b></p>.
0a30: 0a 3c 62 6c 6f 63 6b 71 75 6f 74 65 3e 59 6f 75 .<blockquote>You
0a40: 20 63 61 6e 6e 6f 74 2e 20 20 41 6c 6c 20 62 72 cannot. All br
0a50: 61 6e 63 68 65 73 20 69 6e 20 66 6f 73 73 69 6c anches in fossil
0a60: 20 61 72 65 20 70 75 62 6c 69 63 20 69 6e 20 74 are public in t
0a70: 68 65 20 73 65 6e 73 65 20 74 68 61 74 0a 61 72 he sense that.ar
0a80: 65 20 61 6c 6c 20 70 75 73 68 65 64 20 61 6e 64 e all pushed and
0a90: 20 70 75 6c 6c 65 64 20 74 6f 67 65 74 68 65 72 pulled together
0aa0: 2e 20 20 54 68 65 72 65 20 69 73 20 6e 6f 20 77 . There is no w
0ab0: 61 79 20 74 6f 20 74 65 6c 6c 20 66 6f 73 73 69 ay to tell fossi
0ac0: 6c 0a 74 6f 20 6f 6e 6c 79 20 70 75 73 68 20 6f l.to only push o
0ad0: 72 20 70 75 6c 6c 20 61 20 73 75 62 73 65 74 20 r pull a subset
0ae0: 6f 66 20 62 72 61 6e 63 68 65 73 2e 0a 0a 4f 66 of branches...Of
0af0: 20 63 6f 75 72 73 65 2c 20 61 73 20 6c 6f 6e 67 course, as long
0b00: 20 61 73 20 79 6f 75 20 6e 65 76 65 72 20 70 75 as you never pu
0b10: 73 68 2c 20 79 6f 75 20 63 61 6e 20 6d 61 6b 65 sh, you can make
0b20: 20 61 73 20 6d 61 6e 79 20 70 72 69 76 61 74 65 as many private
0b30: 0a 63 68 61 6e 67 65 73 20 61 73 20 79 6f 75 20 .changes as you
0b40: 77 61 6e 74 2e 3c 2f 62 6c 6f 63 6b 71 75 6f 74 want.</blockquot
0b50: 65 3e 3c 2f 6c 69 3e 0a 0a 3c 2f 6f 6c 3e 0a e></li>..</ol>.