diff options
| author | cashmere <cashmere@autistici.org> | 2026-09-04 09:05:24 +0200 |
|---|---|---|
| committer | cashmere <cashmere@autistici.org> | 2026-09-04 09:05:24 +0200 |
| commit | 4f49b16079b27d7ce633619e4cddfdf2bffbc952 (patch) | |
| tree | c296c1e7f3c3e2f6859c6d3a1b1b208779b89679 /www/faq.wiki | |
| download | relic-4f49b16079b27d7ce633619e4cddfdf2bffbc952.tar.gz | |
Diffstat (limited to 'www/faq.wiki')
| -rw-r--r-- | www/faq.wiki | 149 |
1 files changed, 149 insertions, 0 deletions
diff --git a/www/faq.wiki b/www/faq.wiki new file mode 100644 index 0000000..0c8a9c3 --- /dev/null +++ b/www/faq.wiki @@ -0,0 +1,149 @@ +<title>Fossil FAQ</title> + +Note: See also <a href="qandc.wiki">Questions and Criticisms</a>. + +<ol> +<li><a href="#q1">What GUIs are available for fossil?</a></li> +<li><a href="#q2">What is the difference between a "branch" and a "fork"?</a></li> +<li><a href="#q3">How do I create a new branch?</a></li> +<li><a href="#q4">How do I tag a check-in?</a></li> +<li><a href="#q5">How do I create a private branch that won't get pushed back to the + main repository.</a></li> +<li><a href="#q6">How can I delete inappropriate content from my fossil repository?</a></li> +<li><a href="#q7">How do I make a clone of the fossil self-hosting repository?</a></li> +<li><a href="#q8">How do I import or export content from and to other version control systems?</a></li> +</ol> +<hr> +<p id="q1"><b>(1) What GUIs are available for fossil?</b></p> + +The fossil executable comes with a [./webui.wiki | web-based GUI] built in. +Just run: + +<pre> +<b>fossil [/help/ui|ui]</b> <i>REPOSITORY-FILENAME</i> +</pre> + +And your default web browser should pop up and automatically point to +the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> +if you are within an open check-out.)</li> + +<p id="q2"><b>(2) What is the difference between a "branch" and a "fork"?</b></p> + +This is a big question - too big to answer in a FAQ. Please +read the <a href="branching.wiki">Branching, Forking, Merging, +and Tagging</a> document.</li> + +<p id="q3"><b>(3) How do I create a new branch?</b></p> + +There are lots of ways: + +When you are checking in a new change using the <b>[/help/commit|commit]</b> +command, you can add the option "--branch <i>BRANCH-NAME</i>" to +make the new check-in be the first check-in for a new branch. + +If you want to create a new branch whose initial content is the +same as an existing check-in, use this command: + +<pre> +<b>fossil [/help/branch|branch] new</b> <i>BRANCH-NAME BASIS</i> +</pre> + +The <i>BRANCH-NAME</i> argument is the name of the new branch and the +<i>BASIS</i> argument is the name of the check-in that the branch splits +off from. + +If you already have a fork in your check-in tree and you want to convert +that fork to a branch, you can do this from the web interface. +First locate the check-in that you want to be +the initial check-in of your branch on the timeline and click on its +link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" +link (near the "Commands:" label) and click on that. On the +"Edit Check-in" page, check the box beside "Branching:" and fill in +the name of your new branch to the right and press the "Apply Changes" +button.</li> + +<p id="q4"><b>(4) How do I tag a check-in?</b></p> + +There are several ways: + +When you are checking in a new change using the <b>[/help/commit|commit]</b> +command, you can add a tag to that check-in using the +"--tag <i>TAGNAME</i>" command-line option. You can repeat the --tag +option to give a check-in multiple tags. Tags need not be unique. So, +for example, it is common to give every released version a "release" tag. + +If you want to add a tag to an existing check-in, you can use the +<b>[/help/tag|tag]</b> command. For example: + +<pre> +<b>fossil [/help/branch|tag] add</b> <i>TAGNAME</i> <i>CHECK-IN</i> +</pre> + +The CHECK-IN in the previous line can be any +[./checkin_names.wiki | valid check-in name format]. + +You can also add (and remove) tags from a check-in using the +[./webui.wiki | web interface]. First locate the check-in that you +want to tag on the timeline, then click on the link to go the detailed +information page for that check-in. Then find the "<b>edit</b>" +link (near the "Commands:" label) and click on that. There are +controls on the edit page that allow new tags to be added and existing +tags to be removed.</li> + +<p id="q5"><b>(5) How do I create a private branch that won't get pushed back to the + main repository.</b></p> + +Use the <b>--private</b> command-line option on the +<b>commit</b> command. The result will be a check-in which exists in +your local repository only and is never pushed to other repositories. +All descendants of a private check-in are also private. + +Unless you specify something different using the <b>--branch</b> and/or +<b>--bgcolor</b> options, the new private check-in will be put on a branch +named "private" with an orange background color. + +You can merge from the trunk into your private branch in order to keep +your private branch in sync with the latest changes on the trunk. Once +you have everything in your private branch the way you want it, you can +then merge your private branch back into the trunk and push. Only the +final merge operation will appear in other repositories. It will seem +as if all the changes that occurred on your private branch occurred in +a single check-in. +Of course, you can also keep your branch private forever simply +by not merging the changes in the private branch back into the trunk. + +[./private.wiki | Additional information]</li> + +<p id="q6"><b>(6) How can I delete inappropriate content from my fossil repository?</b></p> + +See the article on [./shunning.wiki | "shunning"] for details.</li> + +<p id="q7"><b>(7) How do I make a clone of the fossil self-hosting repository?</b></p> + +Any of the following commands should work: + +<pre> +fossil [/help/clone|clone] https://fossil-scm.org/ fossil.fossil +fossil [/help/clone|clone] https://www2.fossil-scm.org/ fossil.fossil +fossil [/help/clone|clone] https://www3.fossil-scm.org/site.cgi fossil.fossil +</pre> + +Once you have the repository cloned, you can open a local check-out +as follows: + +<pre> +mkdir src; cd src; fossil [/help/open|open] ../fossil.fossil +</pre> + +Thereafter you should be able to keep your local check-out up to date +with the latest code in the public repository by typing: + +<pre> +fossil [/help/update|update] +</pre></li> + +<p id="q8"><b>(8) How do I import or export content from and to other version control systems?</b></p> + +Please see [./inout.wiki | Import And Export]</li> + +</ol> |
