Fossil SCM
Documentation updates.
Commit
20b2767f46a79e845c319bd7aadec34d84ff9bca
Parent
b6a4e8592d58ead…
3 files changed
+50
-13
+58
-23
+37
-22
+50
-13
| --- www/faq.tcl | ||
| +++ www/faq.tcl | ||
| @@ -9,14 +9,15 @@ | ||
| 9 | 9 | } |
| 10 | 10 | |
| 11 | 11 | faq { |
| 12 | 12 | What GUIs are available for fossil? |
| 13 | 13 | } { |
| 14 | - The fossil executable comes with a web-based GUI built in. Just run: | |
| 14 | + The fossil executable comes with a [./webui.wiki | web-based GUI] built in. | |
| 15 | + Just run: | |
| 15 | 16 | |
| 16 | 17 | <blockquote> |
| 17 | - <b>fossil ui</b> <i>REPOSITORY-FILENAME</i> | |
| 18 | + <b>fossil [/help/ui|ui]</b> <i>REPOSITORY-FILENAME</i> | |
| 18 | 19 | </blockquote> |
| 19 | 20 | |
| 20 | 21 | And your default web browser should pop up and automatically point to |
| 21 | 22 | the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> |
| 22 | 23 | if you are within an open check-out.) |
| @@ -30,41 +31,69 @@ | ||
| 30 | 31 | and Tagging</a> document. |
| 31 | 32 | } |
| 32 | 33 | |
| 33 | 34 | |
| 34 | 35 | faq { |
| 35 | - How do I create a new branch in fossil? | |
| 36 | + How do I create a new branch? | |
| 36 | 37 | } { |
| 37 | 38 | There are lots of ways: |
| 38 | 39 | |
| 39 | - When you are checking in a new change using the <b>commit</b> | |
| 40 | + When you are checking in a new change using the <b>[/help/commit|commit]</b> | |
| 40 | 41 | command, you can add the option "--branch <i>BRANCH-NAME</i>" to |
| 41 | - make the change be the founding check-in for a new branch. You can | |
| 42 | + make the new check-in be the first check-in for a new branch. You can | |
| 42 | 43 | also add the "--bgcolor <i>COLOR</i>" option to give the branch a |
| 43 | 44 | specific background color on timelines. |
| 44 | 45 | |
| 45 | - If you want to create a new branch whose founding check-in is the | |
| 46 | + If you want to create a new branch whose initial content is the | |
| 46 | 47 | same as an existing check-in, use this command: |
| 47 | 48 | |
| 48 | 49 | <blockquote> |
| 49 | - <b>fossil branch new</b> <i>BRANCH-NAME BASIS</i> | |
| 50 | + <b>fossil [/help/branch|branch] new</b> <i>BRANCH-NAME BASIS</i> | |
| 50 | 51 | </blockquote> |
| 51 | 52 | |
| 52 | 53 | The <i>BRANCH-NAME</i> argument is the name of the new branch and the |
| 53 | 54 | <i>BASIS</i> argument is the name of the check-in that the branch splits |
| 54 | 55 | off from. |
| 55 | 56 | |
| 56 | 57 | If you already have a fork in your check-in tree and you want to convert |
| 57 | 58 | that fork to a branch, you can do this from the web interface. |
| 58 | 59 | First locate the check-in that you want to be |
| 59 | - the founding check-in of your branch on the timeline and click on its | |
| 60 | + the initial check-in of your branch on the timeline and click on its | |
| 60 | 61 | link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" |
| 61 | 62 | link (near the "Commands:" label) and click on that. On the |
| 62 | 63 | "Edit Check-in" page, check the box beside "Branching:" and fill in |
| 63 | 64 | the name of your new branch to the right and press the "Apply Changes" |
| 64 | 65 | button. |
| 65 | 66 | } |
| 67 | + | |
| 68 | +faq { | |
| 69 | + How do I tag a check-in? | |
| 70 | +} { | |
| 71 | + There are several ways: | |
| 72 | + | |
| 73 | + When you are checking in a new change using the <b>[/help/commit|commit]</b> | |
| 74 | + command, you can add a tag to that check-in using the | |
| 75 | + "--tag <i>TAGNAME</i>" command-line option. | |
| 76 | + | |
| 77 | + If you want add a tag to an existing check-in, you can use the | |
| 78 | + <b>[/help/tag|tag]</b> command. For example: | |
| 79 | + | |
| 80 | + <blockquote> | |
| 81 | + <b>fossil [/help/branch|tag] add</b> <i>TAGNAME</i> <i>CHECK-IN</i> | |
| 82 | + </blockquote> | |
| 83 | + | |
| 84 | + The CHECK-IN in the previous line can be any | |
| 85 | + [./checkin_names.wiki | valid check-in name format]. | |
| 86 | + | |
| 87 | + You can also add (and remove) tags from a check-in using the | |
| 88 | + [./webui.wiki | web interface]. First locate the check-in that you | |
| 89 | + what to tag on the tmline, then click on the link to go the detailed | |
| 90 | + information page for that check-in. Then find the "<b>edit</b>" | |
| 91 | + link (near the "Commands:" label) and click on that. There are | |
| 92 | + controls on the edit page that allow new tags to be added and existing | |
| 93 | + tags to be removed. | |
| 94 | +} | |
| 66 | 95 | |
| 67 | 96 | faq { |
| 68 | 97 | How do I create a private branch that won't get pushed back to the |
| 69 | 98 | main repository. |
| 70 | 99 | } { |
| @@ -97,25 +126,33 @@ | ||
| 97 | 126 | faq { |
| 98 | 127 | How do I make a clone of the fossil self-hosting repository? |
| 99 | 128 | } { |
| 100 | 129 | Any of the following commands should work: |
| 101 | 130 | <blockquote><pre> |
| 102 | - fossil clone http://www.fossil-scm.org/ fossil.fossil<br> | |
| 103 | - fossil clone http://www2.fossil-scm.org/ fossil.fossil<br> | |
| 104 | - fossil clone http://www.hwaci.com/cgi-bin/fossil fossil.fossil | |
| 131 | + fossil [/help/clone|clone] http://www.fossil-scm.org/ fossil.fossil<br> | |
| 132 | + fossil [/help/clone|clone] http://www2.fossil-scm.org/ fossil.fossil<br> | |
| 133 | + fossil [/help/clone|clone] http://www3.fossli-scm.org/site.cgi fossil.fossil | |
| 105 | 134 | </pre></blockquote> |
| 106 | 135 | Once you have the repository cloned, you can open a local check-out |
| 107 | 136 | as follows: |
| 108 | 137 | <blockquote><pre> |
| 109 | - mkdir src; cd src; fossil open ../fossil.fossil | |
| 138 | + mkdir src; cd src; fossil [/help/open|open] ../fossil.fossil | |
| 110 | 139 | </pre></blockquote> |
| 111 | 140 | Thereafter you should be able to keep your local check-out up to date |
| 112 | 141 | with the latest code in the public repository by typing: |
| 113 | 142 | <blockquote><pre> |
| 114 | - fossil update | |
| 143 | + fossil [/help/update|update] | |
| 115 | 144 | </pre></blockquote> |
| 116 | 145 | } |
| 146 | + | |
| 147 | +faq { | |
| 148 | + How do I import or export content from and to other version control systems? | |
| 149 | +} { | |
| 150 | + Please see [./inout.wiki | Import And Export] | |
| 151 | +} | |
| 152 | + | |
| 153 | + | |
| 117 | 154 | |
| 118 | 155 | ############################################################################# |
| 119 | 156 | # Code to actually generate the FAQ |
| 120 | 157 | # |
| 121 | 158 | puts "<title>Fossil FAQ</title>" |
| 122 | 159 |
| --- www/faq.tcl | |
| +++ www/faq.tcl | |
| @@ -9,14 +9,15 @@ | |
| 9 | } |
| 10 | |
| 11 | faq { |
| 12 | What GUIs are available for fossil? |
| 13 | } { |
| 14 | The fossil executable comes with a web-based GUI built in. Just run: |
| 15 | |
| 16 | <blockquote> |
| 17 | <b>fossil ui</b> <i>REPOSITORY-FILENAME</i> |
| 18 | </blockquote> |
| 19 | |
| 20 | And your default web browser should pop up and automatically point to |
| 21 | the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> |
| 22 | if you are within an open check-out.) |
| @@ -30,41 +31,69 @@ | |
| 30 | and Tagging</a> document. |
| 31 | } |
| 32 | |
| 33 | |
| 34 | faq { |
| 35 | How do I create a new branch in fossil? |
| 36 | } { |
| 37 | There are lots of ways: |
| 38 | |
| 39 | When you are checking in a new change using the <b>commit</b> |
| 40 | command, you can add the option "--branch <i>BRANCH-NAME</i>" to |
| 41 | make the change be the founding check-in for a new branch. You can |
| 42 | also add the "--bgcolor <i>COLOR</i>" option to give the branch a |
| 43 | specific background color on timelines. |
| 44 | |
| 45 | If you want to create a new branch whose founding check-in is the |
| 46 | same as an existing check-in, use this command: |
| 47 | |
| 48 | <blockquote> |
| 49 | <b>fossil branch new</b> <i>BRANCH-NAME BASIS</i> |
| 50 | </blockquote> |
| 51 | |
| 52 | The <i>BRANCH-NAME</i> argument is the name of the new branch and the |
| 53 | <i>BASIS</i> argument is the name of the check-in that the branch splits |
| 54 | off from. |
| 55 | |
| 56 | If you already have a fork in your check-in tree and you want to convert |
| 57 | that fork to a branch, you can do this from the web interface. |
| 58 | First locate the check-in that you want to be |
| 59 | the founding check-in of your branch on the timeline and click on its |
| 60 | link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" |
| 61 | link (near the "Commands:" label) and click on that. On the |
| 62 | "Edit Check-in" page, check the box beside "Branching:" and fill in |
| 63 | the name of your new branch to the right and press the "Apply Changes" |
| 64 | button. |
| 65 | } |
| 66 | |
| 67 | faq { |
| 68 | How do I create a private branch that won't get pushed back to the |
| 69 | main repository. |
| 70 | } { |
| @@ -97,25 +126,33 @@ | |
| 97 | faq { |
| 98 | How do I make a clone of the fossil self-hosting repository? |
| 99 | } { |
| 100 | Any of the following commands should work: |
| 101 | <blockquote><pre> |
| 102 | fossil clone http://www.fossil-scm.org/ fossil.fossil<br> |
| 103 | fossil clone http://www2.fossil-scm.org/ fossil.fossil<br> |
| 104 | fossil clone http://www.hwaci.com/cgi-bin/fossil fossil.fossil |
| 105 | </pre></blockquote> |
| 106 | Once you have the repository cloned, you can open a local check-out |
| 107 | as follows: |
| 108 | <blockquote><pre> |
| 109 | mkdir src; cd src; fossil open ../fossil.fossil |
| 110 | </pre></blockquote> |
| 111 | Thereafter you should be able to keep your local check-out up to date |
| 112 | with the latest code in the public repository by typing: |
| 113 | <blockquote><pre> |
| 114 | fossil update |
| 115 | </pre></blockquote> |
| 116 | } |
| 117 | |
| 118 | ############################################################################# |
| 119 | # Code to actually generate the FAQ |
| 120 | # |
| 121 | puts "<title>Fossil FAQ</title>" |
| 122 |
| --- www/faq.tcl | |
| +++ www/faq.tcl | |
| @@ -9,14 +9,15 @@ | |
| 9 | } |
| 10 | |
| 11 | faq { |
| 12 | What GUIs are available for fossil? |
| 13 | } { |
| 14 | The fossil executable comes with a [./webui.wiki | web-based GUI] built in. |
| 15 | Just run: |
| 16 | |
| 17 | <blockquote> |
| 18 | <b>fossil [/help/ui|ui]</b> <i>REPOSITORY-FILENAME</i> |
| 19 | </blockquote> |
| 20 | |
| 21 | And your default web browser should pop up and automatically point to |
| 22 | the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> |
| 23 | if you are within an open check-out.) |
| @@ -30,41 +31,69 @@ | |
| 31 | and Tagging</a> document. |
| 32 | } |
| 33 | |
| 34 | |
| 35 | faq { |
| 36 | How do I create a new branch? |
| 37 | } { |
| 38 | There are lots of ways: |
| 39 | |
| 40 | When you are checking in a new change using the <b>[/help/commit|commit]</b> |
| 41 | command, you can add the option "--branch <i>BRANCH-NAME</i>" to |
| 42 | make the new check-in be the first check-in for a new branch. You can |
| 43 | also add the "--bgcolor <i>COLOR</i>" option to give the branch a |
| 44 | specific background color on timelines. |
| 45 | |
| 46 | If you want to create a new branch whose initial content is the |
| 47 | same as an existing check-in, use this command: |
| 48 | |
| 49 | <blockquote> |
| 50 | <b>fossil [/help/branch|branch] new</b> <i>BRANCH-NAME BASIS</i> |
| 51 | </blockquote> |
| 52 | |
| 53 | The <i>BRANCH-NAME</i> argument is the name of the new branch and the |
| 54 | <i>BASIS</i> argument is the name of the check-in that the branch splits |
| 55 | off from. |
| 56 | |
| 57 | If you already have a fork in your check-in tree and you want to convert |
| 58 | that fork to a branch, you can do this from the web interface. |
| 59 | First locate the check-in that you want to be |
| 60 | the initial check-in of your branch on the timeline and click on its |
| 61 | link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" |
| 62 | link (near the "Commands:" label) and click on that. On the |
| 63 | "Edit Check-in" page, check the box beside "Branching:" and fill in |
| 64 | the name of your new branch to the right and press the "Apply Changes" |
| 65 | button. |
| 66 | } |
| 67 | |
| 68 | faq { |
| 69 | How do I tag a check-in? |
| 70 | } { |
| 71 | There are several ways: |
| 72 | |
| 73 | When you are checking in a new change using the <b>[/help/commit|commit]</b> |
| 74 | command, you can add a tag to that check-in using the |
| 75 | "--tag <i>TAGNAME</i>" command-line option. |
| 76 | |
| 77 | If you want add a tag to an existing check-in, you can use the |
| 78 | <b>[/help/tag|tag]</b> command. For example: |
| 79 | |
| 80 | <blockquote> |
| 81 | <b>fossil [/help/branch|tag] add</b> <i>TAGNAME</i> <i>CHECK-IN</i> |
| 82 | </blockquote> |
| 83 | |
| 84 | The CHECK-IN in the previous line can be any |
| 85 | [./checkin_names.wiki | valid check-in name format]. |
| 86 | |
| 87 | You can also add (and remove) tags from a check-in using the |
| 88 | [./webui.wiki | web interface]. First locate the check-in that you |
| 89 | what to tag on the tmline, then click on the link to go the detailed |
| 90 | information page for that check-in. Then find the "<b>edit</b>" |
| 91 | link (near the "Commands:" label) and click on that. There are |
| 92 | controls on the edit page that allow new tags to be added and existing |
| 93 | tags to be removed. |
| 94 | } |
| 95 | |
| 96 | faq { |
| 97 | How do I create a private branch that won't get pushed back to the |
| 98 | main repository. |
| 99 | } { |
| @@ -97,25 +126,33 @@ | |
| 126 | faq { |
| 127 | How do I make a clone of the fossil self-hosting repository? |
| 128 | } { |
| 129 | Any of the following commands should work: |
| 130 | <blockquote><pre> |
| 131 | fossil [/help/clone|clone] http://www.fossil-scm.org/ fossil.fossil<br> |
| 132 | fossil [/help/clone|clone] http://www2.fossil-scm.org/ fossil.fossil<br> |
| 133 | fossil [/help/clone|clone] http://www3.fossli-scm.org/site.cgi fossil.fossil |
| 134 | </pre></blockquote> |
| 135 | Once you have the repository cloned, you can open a local check-out |
| 136 | as follows: |
| 137 | <blockquote><pre> |
| 138 | mkdir src; cd src; fossil [/help/open|open] ../fossil.fossil |
| 139 | </pre></blockquote> |
| 140 | Thereafter you should be able to keep your local check-out up to date |
| 141 | with the latest code in the public repository by typing: |
| 142 | <blockquote><pre> |
| 143 | fossil [/help/update|update] |
| 144 | </pre></blockquote> |
| 145 | } |
| 146 | |
| 147 | faq { |
| 148 | How do I import or export content from and to other version control systems? |
| 149 | } { |
| 150 | Please see [./inout.wiki | Import And Export] |
| 151 | } |
| 152 | |
| 153 | |
| 154 | |
| 155 | ############################################################################# |
| 156 | # Code to actually generate the FAQ |
| 157 | # |
| 158 | puts "<title>Fossil FAQ</title>" |
| 159 |
+58
-23
| --- www/faq.wiki | ||
| +++ www/faq.wiki | ||
| @@ -4,24 +4,27 @@ | ||
| 4 | 4 | <p>Note: See also <a href="qandc.wiki">Questions and Criticisms</a>. |
| 5 | 5 | |
| 6 | 6 | <ol> |
| 7 | 7 | <li><a href="#q1">What GUIs are available for fossil?</a></li> |
| 8 | 8 | <li><a href="#q2">What is the difference between a "branch" and a "fork"?</a></li> |
| 9 | -<li><a href="#q3">How do I create a new branch in fossil?</a></li> | |
| 10 | -<li><a href="#q4">How do I create a private branch that won't get pushed back to the | |
| 9 | +<li><a href="#q3">How do I create a new branch?</a></li> | |
| 10 | +<li><a href="#q4">How do I tag a check-in?</a></li> | |
| 11 | +<li><a href="#q5">How do I create a private branch that won't get pushed back to the | |
| 11 | 12 | main repository.</a></li> |
| 12 | -<li><a href="#q5">How can I delete inappropriate content from my fossil repository?</a></li> | |
| 13 | -<li><a href="#q6">How do I make a clone of the fossil self-hosting repository?</a></li> | |
| 13 | +<li><a href="#q6">How can I delete inappropriate content from my fossil repository?</a></li> | |
| 14 | +<li><a href="#q7">How do I make a clone of the fossil self-hosting repository?</a></li> | |
| 15 | +<li><a href="#q8">How do I import or export content from and to other version control systems?</a></li> | |
| 14 | 16 | </ol> |
| 15 | 17 | <hr> |
| 16 | 18 | <a name="q1"></a> |
| 17 | 19 | <p><b>(1) What GUIs are available for fossil?</b></p> |
| 18 | 20 | |
| 19 | -<blockquote>The fossil executable comes with a web-based GUI built in. Just run: | |
| 21 | +<blockquote>The fossil executable comes with a [./webui.wiki | web-based GUI] built in. | |
| 22 | +Just run: | |
| 20 | 23 | |
| 21 | 24 | <blockquote> |
| 22 | -<b>fossil ui</b> <i>REPOSITORY-FILENAME</i> | |
| 25 | +<b>fossil [/help/ui|ui]</b> <i>REPOSITORY-FILENAME</i> | |
| 23 | 26 | </blockquote> |
| 24 | 27 | |
| 25 | 28 | And your default web browser should pop up and automatically point to |
| 26 | 29 | the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> |
| 27 | 30 | if you are within an open check-out.)</blockquote></li> |
| @@ -32,49 +35,76 @@ | ||
| 32 | 35 | <blockquote>This is a big question - too big to answer in a FAQ. Please |
| 33 | 36 | read the <a href="branching.wiki">Branching, Forking, Merging, |
| 34 | 37 | and Tagging</a> document.</blockquote></li> |
| 35 | 38 | |
| 36 | 39 | <a name="q3"></a> |
| 37 | -<p><b>(3) How do I create a new branch in fossil?</b></p> | |
| 40 | +<p><b>(3) How do I create a new branch?</b></p> | |
| 38 | 41 | |
| 39 | 42 | <blockquote>There are lots of ways: |
| 40 | 43 | |
| 41 | -When you are checking in a new change using the <b>commit</b> | |
| 44 | +When you are checking in a new change using the <b>[/help/commit|commit]</b> | |
| 42 | 45 | command, you can add the option "--branch <i>BRANCH-NAME</i>" to |
| 43 | -make the change be the founding check-in for a new branch. You can | |
| 46 | +make the new check-in be the first check-in for a new branch. You can | |
| 44 | 47 | also add the "--bgcolor <i>COLOR</i>" option to give the branch a |
| 45 | 48 | specific background color on timelines. |
| 46 | 49 | |
| 47 | -If you want to create a new branch whose founding check-in is the | |
| 50 | +If you want to create a new branch whose initial content is the | |
| 48 | 51 | same as an existing check-in, use this command: |
| 49 | 52 | |
| 50 | 53 | <blockquote> |
| 51 | -<b>fossil branch new</b> <i>BRANCH-NAME BASIS</i> | |
| 54 | +<b>fossil [/help/branch|branch] new</b> <i>BRANCH-NAME BASIS</i> | |
| 52 | 55 | </blockquote> |
| 53 | 56 | |
| 54 | 57 | The <i>BRANCH-NAME</i> argument is the name of the new branch and the |
| 55 | 58 | <i>BASIS</i> argument is the name of the check-in that the branch splits |
| 56 | 59 | off from. |
| 57 | 60 | |
| 58 | 61 | If you already have a fork in your check-in tree and you want to convert |
| 59 | 62 | that fork to a branch, you can do this from the web interface. |
| 60 | 63 | First locate the check-in that you want to be |
| 61 | -the founding check-in of your branch on the timeline and click on its | |
| 64 | +the initial check-in of your branch on the timeline and click on its | |
| 62 | 65 | link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" |
| 63 | 66 | link (near the "Commands:" label) and click on that. On the |
| 64 | 67 | "Edit Check-in" page, check the box beside "Branching:" and fill in |
| 65 | 68 | the name of your new branch to the right and press the "Apply Changes" |
| 66 | 69 | button.</blockquote></li> |
| 67 | 70 | |
| 68 | 71 | <a name="q4"></a> |
| 69 | -<p><b>(4) How do I create a private branch that won't get pushed back to the | |
| 72 | +<p><b>(4) How do I tag a check-in?</b></p> | |
| 73 | + | |
| 74 | +<blockquote>There are several ways: | |
| 75 | + | |
| 76 | +When you are checking in a new change using the <b>[/help/commit|commit]</b> | |
| 77 | +command, you can add a tag to that check-in using the | |
| 78 | +"--tag <i>TAGNAME</i>" command-line option. | |
| 79 | + | |
| 80 | +If you want add a tag to an existing check-in, you can use the | |
| 81 | +<b>[/help/tag|tag]</b> command. For example: | |
| 82 | + | |
| 83 | +<blockquote> | |
| 84 | +<b>fossil [/help/branch|tag] add</b> <i>TAGNAME</i> <i>CHECK-IN</i> | |
| 85 | +</blockquote> | |
| 86 | + | |
| 87 | +The CHECK-IN in the previous line can be any | |
| 88 | +[./checkin_names.wiki | valid check-in name format]. | |
| 89 | + | |
| 90 | +You can also add (and remove) tags from a check-in using the | |
| 91 | +[./webui.wiki | web interface]. First locate the check-in that you | |
| 92 | +what to tag on the tmline, then click on the link to go the detailed | |
| 93 | +information page for that check-in. Then find the "<b>edit</b>" | |
| 94 | +link (near the "Commands:" label) and click on that. There are | |
| 95 | +controls on the edit page that allow new tags to be added and existing | |
| 96 | +tags to be removed.</blockquote></li> | |
| 97 | + | |
| 98 | +<a name="q5"></a> | |
| 99 | +<p><b>(5) How do I create a private branch that won't get pushed back to the | |
| 70 | 100 | main repository.</b></p> |
| 71 | 101 | |
| 72 | 102 | <blockquote>Use the <b>--private</b> command-line option on the |
| 73 | 103 | <b>commit</b> command. The result will be a check-in which exists on |
| 74 | 104 | your local repository only and is never pushed to other repositories. |
| 75 | -All descendants of a private check-in are also private. | |
| 105 | +All descendents of a private check-in are also private. | |
| 76 | 106 | |
| 77 | 107 | Unless you specify something different using the <b>--branch</b> and/or |
| 78 | 108 | <b>--bgcolor</b> options, the new private check-in will be put on a branch |
| 79 | 109 | named "private" with an orange background color. |
| 80 | 110 | |
| @@ -86,31 +116,36 @@ | ||
| 86 | 116 | as if all the changes that occurred on your private branch occurred in |
| 87 | 117 | a single check-in. |
| 88 | 118 | Of course, you can also keep your branch private forever simply |
| 89 | 119 | by not merging the changes in the private branch back into the trunk.</blockquote></li> |
| 90 | 120 | |
| 91 | -<a name="q5"></a> | |
| 92 | -<p><b>(5) How can I delete inappropriate content from my fossil repository?</b></p> | |
| 121 | +<a name="q6"></a> | |
| 122 | +<p><b>(6) How can I delete inappropriate content from my fossil repository?</b></p> | |
| 93 | 123 | |
| 94 | 124 | <blockquote>See the article on [./shunning.wiki | "shunning"] for details.</blockquote></li> |
| 95 | 125 | |
| 96 | -<a name="q6"></a> | |
| 97 | -<p><b>(6) How do I make a clone of the fossil self-hosting repository?</b></p> | |
| 126 | +<a name="q7"></a> | |
| 127 | +<p><b>(7) How do I make a clone of the fossil self-hosting repository?</b></p> | |
| 98 | 128 | |
| 99 | 129 | <blockquote>Any of the following commands should work: |
| 100 | 130 | <blockquote><pre> |
| 101 | -fossil clone http://www.fossil-scm.org/ fossil.fossil<br> | |
| 102 | -fossil clone http://www2.fossil-scm.org/ fossil.fossil<br> | |
| 103 | -fossil clone http://www.hwaci.com/cgi-bin/fossil fossil.fossil | |
| 131 | +fossil [/help/clone|clone] http://www.fossil-scm.org/ fossil.fossil<br> | |
| 132 | +fossil [/help/clone|clone] http://www2.fossil-scm.org/ fossil.fossil<br> | |
| 133 | +fossil [/help/clone|clone] http://www3.fossli-scm.org/site.cgi fossil.fossil | |
| 104 | 134 | </pre></blockquote> |
| 105 | 135 | Once you have the repository cloned, you can open a local check-out |
| 106 | 136 | as follows: |
| 107 | 137 | <blockquote><pre> |
| 108 | -mkdir src; cd src; fossil open ../fossil.fossil | |
| 138 | +mkdir src; cd src; fossil [/help/open|open] ../fossil.fossil | |
| 109 | 139 | </pre></blockquote> |
| 110 | 140 | Thereafter you should be able to keep your local check-out up to date |
| 111 | 141 | with the latest code in the public repository by typing: |
| 112 | 142 | <blockquote><pre> |
| 113 | -fossil update | |
| 143 | +fossil [/help/update|update] | |
| 114 | 144 | </pre></blockquote></blockquote></li> |
| 115 | 145 | |
| 146 | +<a name="q8"></a> | |
| 147 | +<p><b>(8) How do I import or export content from and to other version control systems?</b></p> | |
| 148 | + | |
| 149 | +<blockquote>Please see [./inout.wiki | Import And Export]</blockquote></li> | |
| 150 | + | |
| 116 | 151 | </ol> |
| 117 | 152 |
| --- www/faq.wiki | |
| +++ www/faq.wiki | |
| @@ -4,24 +4,27 @@ | |
| 4 | <p>Note: See also <a href="qandc.wiki">Questions and Criticisms</a>. |
| 5 | |
| 6 | <ol> |
| 7 | <li><a href="#q1">What GUIs are available for fossil?</a></li> |
| 8 | <li><a href="#q2">What is the difference between a "branch" and a "fork"?</a></li> |
| 9 | <li><a href="#q3">How do I create a new branch in fossil?</a></li> |
| 10 | <li><a href="#q4">How do I create a private branch that won't get pushed back to the |
| 11 | main repository.</a></li> |
| 12 | <li><a href="#q5">How can I delete inappropriate content from my fossil repository?</a></li> |
| 13 | <li><a href="#q6">How do I make a clone of the fossil self-hosting repository?</a></li> |
| 14 | </ol> |
| 15 | <hr> |
| 16 | <a name="q1"></a> |
| 17 | <p><b>(1) What GUIs are available for fossil?</b></p> |
| 18 | |
| 19 | <blockquote>The fossil executable comes with a web-based GUI built in. Just run: |
| 20 | |
| 21 | <blockquote> |
| 22 | <b>fossil ui</b> <i>REPOSITORY-FILENAME</i> |
| 23 | </blockquote> |
| 24 | |
| 25 | And your default web browser should pop up and automatically point to |
| 26 | the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> |
| 27 | if you are within an open check-out.)</blockquote></li> |
| @@ -32,49 +35,76 @@ | |
| 32 | <blockquote>This is a big question - too big to answer in a FAQ. Please |
| 33 | read the <a href="branching.wiki">Branching, Forking, Merging, |
| 34 | and Tagging</a> document.</blockquote></li> |
| 35 | |
| 36 | <a name="q3"></a> |
| 37 | <p><b>(3) How do I create a new branch in fossil?</b></p> |
| 38 | |
| 39 | <blockquote>There are lots of ways: |
| 40 | |
| 41 | When you are checking in a new change using the <b>commit</b> |
| 42 | command, you can add the option "--branch <i>BRANCH-NAME</i>" to |
| 43 | make the change be the founding check-in for a new branch. You can |
| 44 | also add the "--bgcolor <i>COLOR</i>" option to give the branch a |
| 45 | specific background color on timelines. |
| 46 | |
| 47 | If you want to create a new branch whose founding check-in is the |
| 48 | same as an existing check-in, use this command: |
| 49 | |
| 50 | <blockquote> |
| 51 | <b>fossil branch new</b> <i>BRANCH-NAME BASIS</i> |
| 52 | </blockquote> |
| 53 | |
| 54 | The <i>BRANCH-NAME</i> argument is the name of the new branch and the |
| 55 | <i>BASIS</i> argument is the name of the check-in that the branch splits |
| 56 | off from. |
| 57 | |
| 58 | If you already have a fork in your check-in tree and you want to convert |
| 59 | that fork to a branch, you can do this from the web interface. |
| 60 | First locate the check-in that you want to be |
| 61 | the founding check-in of your branch on the timeline and click on its |
| 62 | link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" |
| 63 | link (near the "Commands:" label) and click on that. On the |
| 64 | "Edit Check-in" page, check the box beside "Branching:" and fill in |
| 65 | the name of your new branch to the right and press the "Apply Changes" |
| 66 | button.</blockquote></li> |
| 67 | |
| 68 | <a name="q4"></a> |
| 69 | <p><b>(4) How do I create a private branch that won't get pushed back to the |
| 70 | main repository.</b></p> |
| 71 | |
| 72 | <blockquote>Use the <b>--private</b> command-line option on the |
| 73 | <b>commit</b> command. The result will be a check-in which exists on |
| 74 | your local repository only and is never pushed to other repositories. |
| 75 | All descendants of a private check-in are also private. |
| 76 | |
| 77 | Unless you specify something different using the <b>--branch</b> and/or |
| 78 | <b>--bgcolor</b> options, the new private check-in will be put on a branch |
| 79 | named "private" with an orange background color. |
| 80 | |
| @@ -86,31 +116,36 @@ | |
| 86 | as if all the changes that occurred on your private branch occurred in |
| 87 | a single check-in. |
| 88 | Of course, you can also keep your branch private forever simply |
| 89 | by not merging the changes in the private branch back into the trunk.</blockquote></li> |
| 90 | |
| 91 | <a name="q5"></a> |
| 92 | <p><b>(5) How can I delete inappropriate content from my fossil repository?</b></p> |
| 93 | |
| 94 | <blockquote>See the article on [./shunning.wiki | "shunning"] for details.</blockquote></li> |
| 95 | |
| 96 | <a name="q6"></a> |
| 97 | <p><b>(6) How do I make a clone of the fossil self-hosting repository?</b></p> |
| 98 | |
| 99 | <blockquote>Any of the following commands should work: |
| 100 | <blockquote><pre> |
| 101 | fossil clone http://www.fossil-scm.org/ fossil.fossil<br> |
| 102 | fossil clone http://www2.fossil-scm.org/ fossil.fossil<br> |
| 103 | fossil clone http://www.hwaci.com/cgi-bin/fossil fossil.fossil |
| 104 | </pre></blockquote> |
| 105 | Once you have the repository cloned, you can open a local check-out |
| 106 | as follows: |
| 107 | <blockquote><pre> |
| 108 | mkdir src; cd src; fossil open ../fossil.fossil |
| 109 | </pre></blockquote> |
| 110 | Thereafter you should be able to keep your local check-out up to date |
| 111 | with the latest code in the public repository by typing: |
| 112 | <blockquote><pre> |
| 113 | fossil update |
| 114 | </pre></blockquote></blockquote></li> |
| 115 | |
| 116 | </ol> |
| 117 |
| --- www/faq.wiki | |
| +++ www/faq.wiki | |
| @@ -4,24 +4,27 @@ | |
| 4 | <p>Note: See also <a href="qandc.wiki">Questions and Criticisms</a>. |
| 5 | |
| 6 | <ol> |
| 7 | <li><a href="#q1">What GUIs are available for fossil?</a></li> |
| 8 | <li><a href="#q2">What is the difference between a "branch" and a "fork"?</a></li> |
| 9 | <li><a href="#q3">How do I create a new branch?</a></li> |
| 10 | <li><a href="#q4">How do I tag a check-in?</a></li> |
| 11 | <li><a href="#q5">How do I create a private branch that won't get pushed back to the |
| 12 | main repository.</a></li> |
| 13 | <li><a href="#q6">How can I delete inappropriate content from my fossil repository?</a></li> |
| 14 | <li><a href="#q7">How do I make a clone of the fossil self-hosting repository?</a></li> |
| 15 | <li><a href="#q8">How do I import or export content from and to other version control systems?</a></li> |
| 16 | </ol> |
| 17 | <hr> |
| 18 | <a name="q1"></a> |
| 19 | <p><b>(1) What GUIs are available for fossil?</b></p> |
| 20 | |
| 21 | <blockquote>The fossil executable comes with a [./webui.wiki | web-based GUI] built in. |
| 22 | Just run: |
| 23 | |
| 24 | <blockquote> |
| 25 | <b>fossil [/help/ui|ui]</b> <i>REPOSITORY-FILENAME</i> |
| 26 | </blockquote> |
| 27 | |
| 28 | And your default web browser should pop up and automatically point to |
| 29 | the fossil interface. (Hint: You can omit the <i>REPOSITORY-FILENAME</i> |
| 30 | if you are within an open check-out.)</blockquote></li> |
| @@ -32,49 +35,76 @@ | |
| 35 | <blockquote>This is a big question - too big to answer in a FAQ. Please |
| 36 | read the <a href="branching.wiki">Branching, Forking, Merging, |
| 37 | and Tagging</a> document.</blockquote></li> |
| 38 | |
| 39 | <a name="q3"></a> |
| 40 | <p><b>(3) How do I create a new branch?</b></p> |
| 41 | |
| 42 | <blockquote>There are lots of ways: |
| 43 | |
| 44 | When you are checking in a new change using the <b>[/help/commit|commit]</b> |
| 45 | command, you can add the option "--branch <i>BRANCH-NAME</i>" to |
| 46 | make the new check-in be the first check-in for a new branch. You can |
| 47 | also add the "--bgcolor <i>COLOR</i>" option to give the branch a |
| 48 | specific background color on timelines. |
| 49 | |
| 50 | If you want to create a new branch whose initial content is the |
| 51 | same as an existing check-in, use this command: |
| 52 | |
| 53 | <blockquote> |
| 54 | <b>fossil [/help/branch|branch] new</b> <i>BRANCH-NAME BASIS</i> |
| 55 | </blockquote> |
| 56 | |
| 57 | The <i>BRANCH-NAME</i> argument is the name of the new branch and the |
| 58 | <i>BASIS</i> argument is the name of the check-in that the branch splits |
| 59 | off from. |
| 60 | |
| 61 | If you already have a fork in your check-in tree and you want to convert |
| 62 | that fork to a branch, you can do this from the web interface. |
| 63 | First locate the check-in that you want to be |
| 64 | the initial check-in of your branch on the timeline and click on its |
| 65 | link so that you are on the <b>ci</b> page. Then find the "<b>edit</b>" |
| 66 | link (near the "Commands:" label) and click on that. On the |
| 67 | "Edit Check-in" page, check the box beside "Branching:" and fill in |
| 68 | the name of your new branch to the right and press the "Apply Changes" |
| 69 | button.</blockquote></li> |
| 70 | |
| 71 | <a name="q4"></a> |
| 72 | <p><b>(4) How do I tag a check-in?</b></p> |
| 73 | |
| 74 | <blockquote>There are several ways: |
| 75 | |
| 76 | When you are checking in a new change using the <b>[/help/commit|commit]</b> |
| 77 | command, you can add a tag to that check-in using the |
| 78 | "--tag <i>TAGNAME</i>" command-line option. |
| 79 | |
| 80 | If you want add a tag to an existing check-in, you can use the |
| 81 | <b>[/help/tag|tag]</b> command. For example: |
| 82 | |
| 83 | <blockquote> |
| 84 | <b>fossil [/help/branch|tag] add</b> <i>TAGNAME</i> <i>CHECK-IN</i> |
| 85 | </blockquote> |
| 86 | |
| 87 | The CHECK-IN in the previous line can be any |
| 88 | [./checkin_names.wiki | valid check-in name format]. |
| 89 | |
| 90 | You can also add (and remove) tags from a check-in using the |
| 91 | [./webui.wiki | web interface]. First locate the check-in that you |
| 92 | what to tag on the tmline, then click on the link to go the detailed |
| 93 | information page for that check-in. Then find the "<b>edit</b>" |
| 94 | link (near the "Commands:" label) and click on that. There are |
| 95 | controls on the edit page that allow new tags to be added and existing |
| 96 | tags to be removed.</blockquote></li> |
| 97 | |
| 98 | <a name="q5"></a> |
| 99 | <p><b>(5) How do I create a private branch that won't get pushed back to the |
| 100 | main repository.</b></p> |
| 101 | |
| 102 | <blockquote>Use the <b>--private</b> command-line option on the |
| 103 | <b>commit</b> command. The result will be a check-in which exists on |
| 104 | your local repository only and is never pushed to other repositories. |
| 105 | All descendents of a private check-in are also private. |
| 106 | |
| 107 | Unless you specify something different using the <b>--branch</b> and/or |
| 108 | <b>--bgcolor</b> options, the new private check-in will be put on a branch |
| 109 | named "private" with an orange background color. |
| 110 | |
| @@ -86,31 +116,36 @@ | |
| 116 | as if all the changes that occurred on your private branch occurred in |
| 117 | a single check-in. |
| 118 | Of course, you can also keep your branch private forever simply |
| 119 | by not merging the changes in the private branch back into the trunk.</blockquote></li> |
| 120 | |
| 121 | <a name="q6"></a> |
| 122 | <p><b>(6) How can I delete inappropriate content from my fossil repository?</b></p> |
| 123 | |
| 124 | <blockquote>See the article on [./shunning.wiki | "shunning"] for details.</blockquote></li> |
| 125 | |
| 126 | <a name="q7"></a> |
| 127 | <p><b>(7) How do I make a clone of the fossil self-hosting repository?</b></p> |
| 128 | |
| 129 | <blockquote>Any of the following commands should work: |
| 130 | <blockquote><pre> |
| 131 | fossil [/help/clone|clone] http://www.fossil-scm.org/ fossil.fossil<br> |
| 132 | fossil [/help/clone|clone] http://www2.fossil-scm.org/ fossil.fossil<br> |
| 133 | fossil [/help/clone|clone] http://www3.fossli-scm.org/site.cgi fossil.fossil |
| 134 | </pre></blockquote> |
| 135 | Once you have the repository cloned, you can open a local check-out |
| 136 | as follows: |
| 137 | <blockquote><pre> |
| 138 | mkdir src; cd src; fossil [/help/open|open] ../fossil.fossil |
| 139 | </pre></blockquote> |
| 140 | Thereafter you should be able to keep your local check-out up to date |
| 141 | with the latest code in the public repository by typing: |
| 142 | <blockquote><pre> |
| 143 | fossil [/help/update|update] |
| 144 | </pre></blockquote></blockquote></li> |
| 145 | |
| 146 | <a name="q8"></a> |
| 147 | <p><b>(8) How do I import or export content from and to other version control systems?</b></p> |
| 148 | |
| 149 | <blockquote>Please see [./inout.wiki | Import And Export]</blockquote></li> |
| 150 | |
| 151 | </ol> |
| 152 |
+37
-22
| --- www/webui.wiki | ||
| +++ www/webui.wiki | ||
| @@ -1,42 +1,55 @@ | ||
| 1 | 1 | <title>The Fossil Web Interface</title> |
| 2 | -<h2>Overview</h2> | |
| 3 | 2 | |
| 4 | -One of the innovative features of fossil is its built-in web interface. | |
| 3 | +One of the innovative features of Fossil is its built-in web interface. | |
| 5 | 4 | This web interface provides everything you need to run a software |
| 6 | 5 | development project: |
| 7 | 6 | |
| 8 | 7 | * [./bugtheory.wiki | Ticketing and bug tracking] |
| 9 | 8 | * [./wikitheory.wiki | Wiki] |
| 10 | 9 | * [./embeddeddoc.wiki | On-line documentation] |
| 11 | 10 | * Status information |
| 12 | 11 | * Timelines |
| 12 | + * Graphs of revision and branching history | |
| 13 | + * [./event.wiki | Blogs, News, and Announcements] | |
| 13 | 14 | * File and version lists and differences |
| 15 | + * Download historical versions as ZIP archives | |
| 14 | 16 | * Historical change data |
| 15 | - * Links to download historical versions as ZIP archives | |
| 17 | + * Add and remove tags on checkins | |
| 18 | + * Move checkins between branches | |
| 19 | + * Revise checkin comments | |
| 20 | + * Manage user credentials and access permissions | |
| 21 | + * And so forth... | |
| 16 | 22 | |
| 17 | -You get all of this, and more, for free when you use fossil. | |
| 23 | +You get all of this, and more, for free when you use Fossil. | |
| 18 | 24 | There are no extra programs to install or setup. |
| 19 | 25 | Everything you need is already pre-configured and built into the |
| 20 | -self-contained, stand-alone fossil executable. | |
| 26 | +self-contained, stand-alone Fossil executable. | |
| 21 | 27 | |
| 22 | 28 | As an example of how useful this web interface can be, |
| 23 | -the entire [./index.wiki | fossil website] (except for the | |
| 24 | -[http://www.fossil-scm.org/download.html | precompiled binary download page]), | |
| 29 | +the entire [./index.wiki | Fossil website] (except for the | |
| 30 | +[http://www.fossil-scm.org/download.html | download page]), | |
| 25 | 31 | including the document you are now reading, |
| 26 | -is rendered using the stock fossil web interface, with no enhancements, | |
| 32 | +is rendered using the Fossil web interface, with no enhancements, | |
| 27 | 33 | and little customization. |
| 28 | 34 | |
| 29 | -Note also that because fossil is a distributed system, you can run | |
| 35 | +<blockquote> | |
| 36 | +<b>Key point:</b> <i>The Fossil website is just a running instance | |
| 37 | +of Fossil! | |
| 38 | +</blockquote> | |
| 39 | + | |
| 40 | +Note also that because Fossil is a distributed system, you can run | |
| 30 | 41 | the web interface on your local machine while off network (for example, |
| 31 | 42 | while on an airplane) including |
| 32 | 43 | making changes to wiki pages and/or trouble ticket, then synchronize with your |
| 33 | -co-workers after you reconnect. | |
| 44 | +co-workers after you reconnect. When you clone a Fossil repository, you | |
| 45 | +don't just get the project source code, you get the entire project | |
| 46 | +management website. | |
| 34 | 47 | |
| 35 | 48 | <h2>Drop-Dead Simple Startup</h2> |
| 36 | 49 | |
| 37 | -To start using the built-in fossil web interface on an existing fossil | |
| 50 | +To start using the built-in Fossil web interface on an existing Fossil | |
| 38 | 51 | repository, simply type this: |
| 39 | 52 | |
| 40 | 53 | <b>fossil ui existing-repository.fossil</b> |
| 41 | 54 | |
| 42 | 55 | Substitute the name of your repository, of course. |
| @@ -46,30 +59,32 @@ | ||
| 46 | 59 | from within an open check-out, you can omit the repository name: |
| 47 | 60 | |
| 48 | 61 | <b>fossil ui</b> |
| 49 | 62 | |
| 50 | 63 | The latter case is a very useful short-cut when you are working on a |
| 51 | -fossil project and you want to quickly do some work with the web interface. | |
| 52 | -Notice that fossil automatically finds an unused TCP port to run the | |
| 64 | +Fossil project and you want to quickly do some work with the web interface. | |
| 65 | +Notice that Fossil automatically finds an unused TCP port to run the | |
| 53 | 66 | server own and automatically points your web browser to the correct |
| 54 | 67 | URL. So there is never any fumbling around trying to find an open |
| 55 | 68 | port or to type arcane strings into your browser URL entry box. |
| 56 | 69 | The interface just pops right up, ready to run. |
| 57 | 70 | |
| 58 | -The fossil web interface is also very easy to setup and run on a | |
| 71 | +The Fossil web interface is also very easy to setup and run on a | |
| 59 | 72 | network server, as either a CGI program or from inetd. Details on how |
| 60 | 73 | to do that are described further below. |
| 61 | 74 | |
| 62 | 75 | <h2>Things To Do Using The Web Interface</h2> |
| 63 | 76 | |
| 64 | 77 | You can view <b>timelines</b> of changes to the project. The default |
| 65 | 78 | "Timeline" link on the menu bar takes you to a page that shows the 20 |
| 66 | -most recent check-ins, wiki page edits, and ticket/bug-report changes. | |
| 79 | +most recent check-ins, wiki page edits, ticket/bug-report changes, | |
| 80 | +and/or blog entries. | |
| 67 | 81 | This gives a very useful snapshot of what has been happening lately on the |
| 68 | 82 | project. You can click to go further back in time, if needed. Or |
| 69 | 83 | follow hyperlinks to see details, including diffs and annotated diffs, |
| 70 | -of individual check-ins, wiki page edits, or ticket changes. | |
| 84 | +of individual check-ins, wiki page edits, ticket changes, and | |
| 85 | +blog edits. | |
| 71 | 86 | |
| 72 | 87 | You can view and edit <b>tickets and bug reports</b> by following the |
| 73 | 88 | "Tickets" link on the menu bar. |
| 74 | 89 | Fossil is backed by an SQL database, so users with appropriate permissions |
| 75 | 90 | can write new ticket report formats based on SQL query statements. |
| @@ -87,12 +102,12 @@ | ||
| 87 | 102 | [/wiki_rules | wiki formatting rules] so you won't have to spend a lot |
| 88 | 103 | of time learning a new markup language. And, as with tickets, all of |
| 89 | 104 | your edits will automatically merge with those of your co-workers when |
| 90 | 105 | your repository synchronizes. |
| 91 | 106 | |
| 92 | -You can view summary reports of <b>leaves and branches</b> in the | |
| 93 | -check-in graph by visiting the "Leaves" or "Branches" links on the | |
| 107 | +You can view summary reports of <b>branches</b> in the | |
| 108 | +check-in graph by visiting the "Branche" links on the | |
| 94 | 109 | menu bar. From those pages you can follow hyperlinks to get additional |
| 95 | 110 | details. These screens allow you to easily keep track of what is going |
| 96 | 111 | on with separate subteams within your project team. |
| 97 | 112 | |
| 98 | 113 | The "Files" link on the menu allows you to browse though the <b>file |
| @@ -117,11 +132,11 @@ | ||
| 117 | 132 | up as the "Home" page can be changed. It is often useful to set the |
| 118 | 133 | "Home" page to be a wiki page or an embedded document. |
| 119 | 134 | |
| 120 | 135 | <h2>Installing On A Network Server</h2> |
| 121 | 136 | |
| 122 | -When you create a new fossil project and after you have configured it | |
| 137 | +When you create a new Fossil project and after you have configured it | |
| 123 | 138 | like you want it using the web interface, you can make the project |
| 124 | 139 | available to a distributed team by simply copying the single |
| 125 | 140 | repository file up to a web server that supports CGI. Just put the |
| 126 | 141 | <b>sample-project.fossil</b> file in a directory where CGI scripts |
| 127 | 142 | have both read and write permission on the file and the directory that |
| @@ -131,18 +146,18 @@ | ||
| 131 | 146 | #!/usr/local/bin/fossil |
| 132 | 147 | repository: /home/www/sample-project.fossil |
| 133 | 148 | </verbatim> |
| 134 | 149 | |
| 135 | 150 | Adjust the script above so that the paths are correct for your system, |
| 136 | -of course, and also make sure the fossil binary is installed on the server. | |
| 151 | +of course, and also make sure the Fossil binary is installed on the server. | |
| 137 | 152 | But that is <u>all</u> you have to do. You now have everything you need to host |
| 138 | 153 | a distributed software development project in less than five minutes using a |
| 139 | 154 | two-line CGI script. |
| 140 | 155 | |
| 141 | 156 | You don't have a CGI-capable web server running on your server machine? |
| 142 | -Not a problem. The fossil interface can also be launched via inetd or | |
| 143 | -xinetd. An inetd configuration line sufficient to launch the fossil | |
| 157 | +Not a problem. The Fossil interface can also be launched via inetd or | |
| 158 | +xinetd. An inetd configuration line sufficient to launch the Fossil | |
| 144 | 159 | web interface looks like this: |
| 145 | 160 | |
| 146 | 161 | <verbatim> |
| 147 | 162 | 80 stream tcp nowait.1000 root /usr/local/bin/fossil \ |
| 148 | 163 | /usr/local/bin/fossil http /home/www/sample-project.fossil |
| 149 | 164 |
| --- www/webui.wiki | |
| +++ www/webui.wiki | |
| @@ -1,42 +1,55 @@ | |
| 1 | <title>The Fossil Web Interface</title> |
| 2 | <h2>Overview</h2> |
| 3 | |
| 4 | One of the innovative features of fossil is its built-in web interface. |
| 5 | This web interface provides everything you need to run a software |
| 6 | development project: |
| 7 | |
| 8 | * [./bugtheory.wiki | Ticketing and bug tracking] |
| 9 | * [./wikitheory.wiki | Wiki] |
| 10 | * [./embeddeddoc.wiki | On-line documentation] |
| 11 | * Status information |
| 12 | * Timelines |
| 13 | * File and version lists and differences |
| 14 | * Historical change data |
| 15 | * Links to download historical versions as ZIP archives |
| 16 | |
| 17 | You get all of this, and more, for free when you use fossil. |
| 18 | There are no extra programs to install or setup. |
| 19 | Everything you need is already pre-configured and built into the |
| 20 | self-contained, stand-alone fossil executable. |
| 21 | |
| 22 | As an example of how useful this web interface can be, |
| 23 | the entire [./index.wiki | fossil website] (except for the |
| 24 | [http://www.fossil-scm.org/download.html | precompiled binary download page]), |
| 25 | including the document you are now reading, |
| 26 | is rendered using the stock fossil web interface, with no enhancements, |
| 27 | and little customization. |
| 28 | |
| 29 | Note also that because fossil is a distributed system, you can run |
| 30 | the web interface on your local machine while off network (for example, |
| 31 | while on an airplane) including |
| 32 | making changes to wiki pages and/or trouble ticket, then synchronize with your |
| 33 | co-workers after you reconnect. |
| 34 | |
| 35 | <h2>Drop-Dead Simple Startup</h2> |
| 36 | |
| 37 | To start using the built-in fossil web interface on an existing fossil |
| 38 | repository, simply type this: |
| 39 | |
| 40 | <b>fossil ui existing-repository.fossil</b> |
| 41 | |
| 42 | Substitute the name of your repository, of course. |
| @@ -46,30 +59,32 @@ | |
| 46 | from within an open check-out, you can omit the repository name: |
| 47 | |
| 48 | <b>fossil ui</b> |
| 49 | |
| 50 | The latter case is a very useful short-cut when you are working on a |
| 51 | fossil project and you want to quickly do some work with the web interface. |
| 52 | Notice that fossil automatically finds an unused TCP port to run the |
| 53 | server own and automatically points your web browser to the correct |
| 54 | URL. So there is never any fumbling around trying to find an open |
| 55 | port or to type arcane strings into your browser URL entry box. |
| 56 | The interface just pops right up, ready to run. |
| 57 | |
| 58 | The fossil web interface is also very easy to setup and run on a |
| 59 | network server, as either a CGI program or from inetd. Details on how |
| 60 | to do that are described further below. |
| 61 | |
| 62 | <h2>Things To Do Using The Web Interface</h2> |
| 63 | |
| 64 | You can view <b>timelines</b> of changes to the project. The default |
| 65 | "Timeline" link on the menu bar takes you to a page that shows the 20 |
| 66 | most recent check-ins, wiki page edits, and ticket/bug-report changes. |
| 67 | This gives a very useful snapshot of what has been happening lately on the |
| 68 | project. You can click to go further back in time, if needed. Or |
| 69 | follow hyperlinks to see details, including diffs and annotated diffs, |
| 70 | of individual check-ins, wiki page edits, or ticket changes. |
| 71 | |
| 72 | You can view and edit <b>tickets and bug reports</b> by following the |
| 73 | "Tickets" link on the menu bar. |
| 74 | Fossil is backed by an SQL database, so users with appropriate permissions |
| 75 | can write new ticket report formats based on SQL query statements. |
| @@ -87,12 +102,12 @@ | |
| 87 | [/wiki_rules | wiki formatting rules] so you won't have to spend a lot |
| 88 | of time learning a new markup language. And, as with tickets, all of |
| 89 | your edits will automatically merge with those of your co-workers when |
| 90 | your repository synchronizes. |
| 91 | |
| 92 | You can view summary reports of <b>leaves and branches</b> in the |
| 93 | check-in graph by visiting the "Leaves" or "Branches" links on the |
| 94 | menu bar. From those pages you can follow hyperlinks to get additional |
| 95 | details. These screens allow you to easily keep track of what is going |
| 96 | on with separate subteams within your project team. |
| 97 | |
| 98 | The "Files" link on the menu allows you to browse though the <b>file |
| @@ -117,11 +132,11 @@ | |
| 117 | up as the "Home" page can be changed. It is often useful to set the |
| 118 | "Home" page to be a wiki page or an embedded document. |
| 119 | |
| 120 | <h2>Installing On A Network Server</h2> |
| 121 | |
| 122 | When you create a new fossil project and after you have configured it |
| 123 | like you want it using the web interface, you can make the project |
| 124 | available to a distributed team by simply copying the single |
| 125 | repository file up to a web server that supports CGI. Just put the |
| 126 | <b>sample-project.fossil</b> file in a directory where CGI scripts |
| 127 | have both read and write permission on the file and the directory that |
| @@ -131,18 +146,18 @@ | |
| 131 | #!/usr/local/bin/fossil |
| 132 | repository: /home/www/sample-project.fossil |
| 133 | </verbatim> |
| 134 | |
| 135 | Adjust the script above so that the paths are correct for your system, |
| 136 | of course, and also make sure the fossil binary is installed on the server. |
| 137 | But that is <u>all</u> you have to do. You now have everything you need to host |
| 138 | a distributed software development project in less than five minutes using a |
| 139 | two-line CGI script. |
| 140 | |
| 141 | You don't have a CGI-capable web server running on your server machine? |
| 142 | Not a problem. The fossil interface can also be launched via inetd or |
| 143 | xinetd. An inetd configuration line sufficient to launch the fossil |
| 144 | web interface looks like this: |
| 145 | |
| 146 | <verbatim> |
| 147 | 80 stream tcp nowait.1000 root /usr/local/bin/fossil \ |
| 148 | /usr/local/bin/fossil http /home/www/sample-project.fossil |
| 149 |
| --- www/webui.wiki | |
| +++ www/webui.wiki | |
| @@ -1,42 +1,55 @@ | |
| 1 | <title>The Fossil Web Interface</title> |
| 2 | |
| 3 | One of the innovative features of Fossil is its built-in web interface. |
| 4 | This web interface provides everything you need to run a software |
| 5 | development project: |
| 6 | |
| 7 | * [./bugtheory.wiki | Ticketing and bug tracking] |
| 8 | * [./wikitheory.wiki | Wiki] |
| 9 | * [./embeddeddoc.wiki | On-line documentation] |
| 10 | * Status information |
| 11 | * Timelines |
| 12 | * Graphs of revision and branching history |
| 13 | * [./event.wiki | Blogs, News, and Announcements] |
| 14 | * File and version lists and differences |
| 15 | * Download historical versions as ZIP archives |
| 16 | * Historical change data |
| 17 | * Add and remove tags on checkins |
| 18 | * Move checkins between branches |
| 19 | * Revise checkin comments |
| 20 | * Manage user credentials and access permissions |
| 21 | * And so forth... |
| 22 | |
| 23 | You get all of this, and more, for free when you use Fossil. |
| 24 | There are no extra programs to install or setup. |
| 25 | Everything you need is already pre-configured and built into the |
| 26 | self-contained, stand-alone Fossil executable. |
| 27 | |
| 28 | As an example of how useful this web interface can be, |
| 29 | the entire [./index.wiki | Fossil website] (except for the |
| 30 | [http://www.fossil-scm.org/download.html | download page]), |
| 31 | including the document you are now reading, |
| 32 | is rendered using the Fossil web interface, with no enhancements, |
| 33 | and little customization. |
| 34 | |
| 35 | <blockquote> |
| 36 | <b>Key point:</b> <i>The Fossil website is just a running instance |
| 37 | of Fossil! |
| 38 | </blockquote> |
| 39 | |
| 40 | Note also that because Fossil is a distributed system, you can run |
| 41 | the web interface on your local machine while off network (for example, |
| 42 | while on an airplane) including |
| 43 | making changes to wiki pages and/or trouble ticket, then synchronize with your |
| 44 | co-workers after you reconnect. When you clone a Fossil repository, you |
| 45 | don't just get the project source code, you get the entire project |
| 46 | management website. |
| 47 | |
| 48 | <h2>Drop-Dead Simple Startup</h2> |
| 49 | |
| 50 | To start using the built-in Fossil web interface on an existing Fossil |
| 51 | repository, simply type this: |
| 52 | |
| 53 | <b>fossil ui existing-repository.fossil</b> |
| 54 | |
| 55 | Substitute the name of your repository, of course. |
| @@ -46,30 +59,32 @@ | |
| 59 | from within an open check-out, you can omit the repository name: |
| 60 | |
| 61 | <b>fossil ui</b> |
| 62 | |
| 63 | The latter case is a very useful short-cut when you are working on a |
| 64 | Fossil project and you want to quickly do some work with the web interface. |
| 65 | Notice that Fossil automatically finds an unused TCP port to run the |
| 66 | server own and automatically points your web browser to the correct |
| 67 | URL. So there is never any fumbling around trying to find an open |
| 68 | port or to type arcane strings into your browser URL entry box. |
| 69 | The interface just pops right up, ready to run. |
| 70 | |
| 71 | The Fossil web interface is also very easy to setup and run on a |
| 72 | network server, as either a CGI program or from inetd. Details on how |
| 73 | to do that are described further below. |
| 74 | |
| 75 | <h2>Things To Do Using The Web Interface</h2> |
| 76 | |
| 77 | You can view <b>timelines</b> of changes to the project. The default |
| 78 | "Timeline" link on the menu bar takes you to a page that shows the 20 |
| 79 | most recent check-ins, wiki page edits, ticket/bug-report changes, |
| 80 | and/or blog entries. |
| 81 | This gives a very useful snapshot of what has been happening lately on the |
| 82 | project. You can click to go further back in time, if needed. Or |
| 83 | follow hyperlinks to see details, including diffs and annotated diffs, |
| 84 | of individual check-ins, wiki page edits, ticket changes, and |
| 85 | blog edits. |
| 86 | |
| 87 | You can view and edit <b>tickets and bug reports</b> by following the |
| 88 | "Tickets" link on the menu bar. |
| 89 | Fossil is backed by an SQL database, so users with appropriate permissions |
| 90 | can write new ticket report formats based on SQL query statements. |
| @@ -87,12 +102,12 @@ | |
| 102 | [/wiki_rules | wiki formatting rules] so you won't have to spend a lot |
| 103 | of time learning a new markup language. And, as with tickets, all of |
| 104 | your edits will automatically merge with those of your co-workers when |
| 105 | your repository synchronizes. |
| 106 | |
| 107 | You can view summary reports of <b>branches</b> in the |
| 108 | check-in graph by visiting the "Branche" links on the |
| 109 | menu bar. From those pages you can follow hyperlinks to get additional |
| 110 | details. These screens allow you to easily keep track of what is going |
| 111 | on with separate subteams within your project team. |
| 112 | |
| 113 | The "Files" link on the menu allows you to browse though the <b>file |
| @@ -117,11 +132,11 @@ | |
| 132 | up as the "Home" page can be changed. It is often useful to set the |
| 133 | "Home" page to be a wiki page or an embedded document. |
| 134 | |
| 135 | <h2>Installing On A Network Server</h2> |
| 136 | |
| 137 | When you create a new Fossil project and after you have configured it |
| 138 | like you want it using the web interface, you can make the project |
| 139 | available to a distributed team by simply copying the single |
| 140 | repository file up to a web server that supports CGI. Just put the |
| 141 | <b>sample-project.fossil</b> file in a directory where CGI scripts |
| 142 | have both read and write permission on the file and the directory that |
| @@ -131,18 +146,18 @@ | |
| 146 | #!/usr/local/bin/fossil |
| 147 | repository: /home/www/sample-project.fossil |
| 148 | </verbatim> |
| 149 | |
| 150 | Adjust the script above so that the paths are correct for your system, |
| 151 | of course, and also make sure the Fossil binary is installed on the server. |
| 152 | But that is <u>all</u> you have to do. You now have everything you need to host |
| 153 | a distributed software development project in less than five minutes using a |
| 154 | two-line CGI script. |
| 155 | |
| 156 | You don't have a CGI-capable web server running on your server machine? |
| 157 | Not a problem. The Fossil interface can also be launched via inetd or |
| 158 | xinetd. An inetd configuration line sufficient to launch the Fossil |
| 159 | web interface looks like this: |
| 160 | |
| 161 | <verbatim> |
| 162 | 80 stream tcp nowait.1000 root /usr/local/bin/fossil \ |
| 163 | /usr/local/bin/fossil http /home/www/sample-project.fossil |
| 164 |