522824b26a 2009-08-28 drh: <title>Fossil FAQ</title> 627de3bf16 2009-01-25 drh: <h1 align="center">Frequently Asked Questions</h1> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <p>Note: See also <a href="qandc.wiki">Questions and Criticisms</a>. 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <ol> 627de3bf16 2009-01-25 drh: <li><a href="#q1">What GUIs are available for fossil?</a></li> 627de3bf16 2009-01-25 drh: <li><a href="#q2">What is the difference between a "branch" and a "fork"?</a></li> 627de3bf16 2009-01-25 drh: <li><a href="#q3">How do I create a new branch in fossil?</a></li> 627de3bf16 2009-01-25 drh: <li><a href="#q4">How do I create a private branch that won't get pushed back to the 627de3bf16 2009-01-25 drh: main repository.</a></li> d6b8b5ba73 2009-08-26 drh: <li><a href="#q5">How can I delete inappropriate content from my fossil repository?</a></li> 68b73eb9b9 2009-08-28 drh: <li><a href="#q6">How do I make a clone of the fossil self-hosting repository?</a></li> 627de3bf16 2009-01-25 drh: </ol> 627de3bf16 2009-01-25 drh: <hr> 627de3bf16 2009-01-25 drh: <a name="q1"></a> 627de3bf16 2009-01-25 drh: <p><b>(1) What GUIs are available for fossil?</b></p> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <blockquote>The fossil executable comes with a web-based GUI built in. Just run: 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <blockquote> 627de3bf16 2009-01-25 drh: <b>fossil ui</b> <i>REPOSITORY-FILENAME</i> 627de3bf16 2009-01-25 drh: </blockquote> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: And your default web browser should pop up and automatically point to 627de3bf16 2009-01-25 drh: the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> 627de3bf16 2009-01-25 drh: if you are within an open check-out.)</blockquote></li> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <a name="q2"></a> 627de3bf16 2009-01-25 drh: <p><b>(2) What is the difference between a "branch" and a "fork"?</b></p> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <blockquote>This is a big question - too big to answer in a FAQ. Please 627de3bf16 2009-01-25 drh: read the <a href="branching.wiki">Branching, Forking, Merging, 627de3bf16 2009-01-25 drh: and Tagging</a> document.</blockquote></li> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <a name="q3"></a> 627de3bf16 2009-01-25 drh: <p><b>(3) How do I create a new branch in fossil?</b></p> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <blockquote>There are lots of ways: 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: When you are checking in a new change using the <b>commit</b> 627de3bf16 2009-01-25 drh: command, you can add the option "--branch <i>BRANCH-NAME</i>" to 627de3bf16 2009-01-25 drh: make the change be the founding check-in for a new branch. You can 627de3bf16 2009-01-25 drh: also add the "--bgcolor <i>COLOR</i>" option to give the branch a 627de3bf16 2009-01-25 drh: specific background color on timelines. 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: If you want to create a new branch whose founding check-in is the 627de3bf16 2009-01-25 drh: same as an existing check-in, use this command: 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <blockquote> 627de3bf16 2009-01-25 drh: <b>fossil branch new</b> <i>BRANCH-NAME BASIS</i> 627de3bf16 2009-01-25 drh: </blockquote> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: The <i>BRANCH-NAME</i> argument is the name of the new branch and the 627de3bf16 2009-01-25 drh: <i>BASIS</i> argument is the name of the check-in that the branch splits 627de3bf16 2009-01-25 drh: off from. 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: If you already have a fork in your check-in tree and you want to convert 627de3bf16 2009-01-25 drh: that fork to a branch, you can do this from the web interface. 627de3bf16 2009-01-25 drh: First locate the check-in that you want to be 627de3bf16 2009-01-25 drh: the founding check-in of your branch on the timeline and click on its 627de3bf16 2009-01-25 drh: link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" 627de3bf16 2009-01-25 drh: link (near the "Commands:" label) and click on that. On the 627de3bf16 2009-01-25 drh: "Edit Check-in" page, check the box beside "Branching:" and fill in 627de3bf16 2009-01-25 drh: the name of your new branch to the right and press the "Apply Changes" 627de3bf16 2009-01-25 drh: button.</blockquote></li> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: <a name="q4"></a> 627de3bf16 2009-01-25 drh: <p><b>(4) How do I create a private branch that won't get pushed back to the 627de3bf16 2009-01-25 drh: main repository.</b></p> 627de3bf16 2009-01-25 drh: 85c6542a16 2009-08-26 drh: <blockquote>Use the <b>--private</b> command-line option on the 85c6542a16 2009-08-26 drh: <b>commit</b> command. The result will be a check-in which exists on 85c6542a16 2009-08-26 drh: your local repository only and is never pushed to other repositories. 85c6542a16 2009-08-26 drh: All descendents of a private check-in are also private. 85c6542a16 2009-08-26 drh: 85c6542a16 2009-08-26 drh: Unless you specify something different using the <b>--branch</b> and/or 85c6542a16 2009-08-26 drh: <b>--bgcolor</b> options, the new private check-in will be put on a branch 85c6542a16 2009-08-26 drh: named "private" with an orange background color. 85c6542a16 2009-08-26 drh: 85c6542a16 2009-08-26 drh: You can merge from the trunk into your private branch in order to keep 85c6542a16 2009-08-26 drh: your private branch in sync with the latest changes on the trunk. Once 85c6542a16 2009-08-26 drh: you have everything in your private branch the way you want it, you can 85c6542a16 2009-08-26 drh: then merge your private branch back into the trunk and push. Only the d6b8b5ba73 2009-08-26 drh: final merge operation will appear in other repositories. It will seem 85c6542a16 2009-08-26 drh: as if all the changes that occurred on your private branch occurred in 85c6542a16 2009-08-26 drh: a single check-in. d6b8b5ba73 2009-08-26 drh: Of course, you can also keep your branch private forever simply d6b8b5ba73 2009-08-26 drh: by not merging the changes in the private branch back into the trunk.</blockquote></li> d6b8b5ba73 2009-08-26 drh: d6b8b5ba73 2009-08-26 drh: <a name="q5"></a> d6b8b5ba73 2009-08-26 drh: <p><b>(5) How can I delete inappropriate content from my fossil repository?</b></p> d6b8b5ba73 2009-08-26 drh: d6b8b5ba73 2009-08-26 drh: <blockquote>See the article on [./shunning.wiki | "shunning"] for details.</blockquote></li> 68b73eb9b9 2009-08-28 drh: 68b73eb9b9 2009-08-28 drh: <a name="q6"></a> 68b73eb9b9 2009-08-28 drh: <p><b>(6) How do I make a clone of the fossil self-hosting repository?</b></p> 627de3bf16 2009-01-25 drh: 68b73eb9b9 2009-08-28 drh: <blockquote>Any of the following commands should work: 68b73eb9b9 2009-08-28 drh: <blockquote><pre> 68b73eb9b9 2009-08-28 drh: fossil clone http://www.fossil-scm.org/ fossil.fossil<br> 68b73eb9b9 2009-08-28 drh: fossil clone http://www2.fossil-scm.org/ fossil.fossil<br> 68b73eb9b9 2009-08-28 drh: fossil clone http://www.hwaci.com/cgi-bin/fossil fossil.fossil 68b73eb9b9 2009-08-28 drh: </pre></blockquote> 68b73eb9b9 2009-08-28 drh: Once you have the repository cloned, you can open a local check-out 68b73eb9b9 2009-08-28 drh: as follows: 68b73eb9b9 2009-08-28 drh: <blockquote><pre> 68b73eb9b9 2009-08-28 drh: mkdir fossil; cd fossil; fossil open ../fossil.fossil 68b73eb9b9 2009-08-28 drh: </pre></blockquote> 68b73eb9b9 2009-08-28 drh: Thereafter you should be able to keep your local check-out up to date 68b73eb9b9 2009-08-28 drh: with the latest code in the public repository simply by typing: 68b73eb9b9 2009-08-28 drh: <blockquote><pre> 68b73eb9b9 2009-08-28 drh: fossil update 68b73eb9b9 2009-08-28 drh: </pre></blockquote></blockquote></li> 627de3bf16 2009-01-25 drh: 627de3bf16 2009-01-25 drh: </ol>
File Annotation