Fossil SCM
Documentation tweaks.
Commit
06689854aee056442322467e836a0686f3ee3ee5
Parent
b9eec2d2772ec5a…
3 files changed
+1
+18
-10
+20
-12
+1
| --- www/build.wiki | ||
| +++ www/build.wiki | ||
| @@ -1,5 +1,6 @@ | ||
| 1 | +<nowiki> | |
| 1 | 2 | <h1>Installing Fossil</h1> |
| 2 | 3 | |
| 3 | 4 | <p>This page describes how to build and install Fossil. The |
| 4 | 5 | whole process is designed to be very easy.</p> |
| 5 | 6 | |
| 6 | 7 |
| --- www/build.wiki | |
| +++ www/build.wiki | |
| @@ -1,5 +1,6 @@ | |
| 1 | <h1>Installing Fossil</h1> |
| 2 | |
| 3 | <p>This page describes how to build and install Fossil. The |
| 4 | whole process is designed to be very easy.</p> |
| 5 | |
| 6 |
| --- www/build.wiki | |
| +++ www/build.wiki | |
| @@ -1,5 +1,6 @@ | |
| 1 | <nowiki> |
| 2 | <h1>Installing Fossil</h1> |
| 3 | |
| 4 | <p>This page describes how to build and install Fossil. The |
| 5 | whole process is designed to be very easy.</p> |
| 6 | |
| 7 |
+18
-10
| --- www/index.wiki | ||
| +++ www/index.wiki | ||
| @@ -4,15 +4,17 @@ | ||
| 4 | 4 | Fossil is a new |
| 5 | 5 | <a href="http://en.wikipedia.org/wiki/Revision_control"> |
| 6 | 6 | distributed software revision control system</a> that includes an integrated |
| 7 | 7 | <a href="http://en.wikipedia.org/wiki/Wiki">Wiki</a> and an integrated |
| 8 | 8 | <a href="http://en.wikipedia.org/wiki/Bugtracker"> |
| 9 | -bug-tracking system</a> all into a single easy-to-use stand-alone | |
| 9 | +bug-tracking system</a> all in a single easy-to-use stand-alone | |
| 10 | 10 | executable. |
| 11 | -(NB: The bug-tracker component is still not completely functional...) | |
| 11 | +(NB: The bug-tracker component is still not completely functional yet, but | |
| 12 | +we expect it to be available soon.) | |
| 12 | 13 | Fossil is |
| 13 | -<a href="http://www.fossil-scm.org/fossil/timeline">self-hosting</a> on | |
| 14 | +<a href="http://www.fossil-scm.org/fossil/timeline">self-hosting</a> | |
| 15 | +since 2007-07-21 on | |
| 14 | 16 | <a href="http://www.hwaci.com/cgi-bin/fossil/timeline">two separate servers</a>. |
| 15 | 17 | You can download the lastest sources |
| 16 | 18 | compile it yourself using the instructions below. |
| 17 | 19 | Or you can grab |
| 18 | 20 | <a href="http://www.fossil-scm.org/download.html">precompiled binaries</a>. |
| @@ -79,31 +81,37 @@ | ||
| 79 | 81 | <a href="http://www.oreillynet.com/pub/a/oreilly/tim/news/2005/09/30/what-is-web-20.html">Web 2.0</a>. |
| 80 | 82 | Fossil attempts to better capture "collective intelligence" and |
| 81 | 83 | "the wisdom of crowds" by opening up write access to the masses.</li> |
| 82 | 84 | </ul> |
| 83 | 85 | |
| 84 | -<p>Other Links:</p> | |
| 86 | +<p>User Links:</p> | |
| 85 | 87 | |
| 86 | 88 | <ul> |
| 87 | 89 | <li>The <a href="concepts.wiki">concepts</b> behind fossil</li> |
| 88 | 90 | <li><a href="build.wiki">Building And Installing</a></li> |
| 89 | 91 | <li><a href="quickstart.wiki">Quick Start</a> guide to using fossil |
| 90 | -<li><a href="pop.wiki">Principles Of Operation</a></li> | |
| 91 | 92 | <li>The <a href="selfcheck.wiki">automatic self-check</a> mechanism |
| 92 | 93 | helps insure project integrity.</li> |
| 94 | +<li>The <a href="http://www.fossil-scm.org/fossil/wiki">self-hosting | |
| 95 | + fossil wiki</a>, capable of hosting static pages and community-editable wiki | |
| 96 | + content.</li> | |
| 97 | +<li>There is a | |
| 98 | + <a href="http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users"> | |
| 99 | + mailing list</a> available for discussing fossil issues.</li> | |
| 100 | +</ul> | |
| 101 | + | |
| 102 | +<p>Developer Links: </p> | |
| 103 | + | |
| 104 | +<ul> | |
| 105 | +<li><a href="pop.wiki">Principles Of Operation</a></li> | |
| 93 | 106 | <li>The <a href="fileformat.wiki">file format</a> used by every content |
| 94 | 107 | file stored in the repository.</li> |
| 95 | 108 | <li>The <a href="delta_format.wiki">format of deltas</a> used to |
| 96 | 109 | efficiently store changes between file revisions.</li> |
| 97 | 110 | <li>The <a href="delta_encoder_algorithm.wiki">encoder algorithm</a> used to |
| 98 | 111 | efficiently generate deltas.</li> |
| 99 | 112 | <li>The <a href="sync.wiki">synchronization protocol</a>.</li> |
| 100 | -<li>There is a <a href="http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users"> | |
| 101 | - mailing list</a> available for discussing fossil issues.</li> | |
| 102 | -<li>The <a href="http://www.fossil-scm.org/fossil/wiki">self-hosting | |
| 103 | - fossil wiki</a>, capable of hosting static pages and community-editable wiki | |
| 104 | - content.</li> | |
| 105 | 113 | </ul> |
| 106 | 114 | |
| 107 | 115 | <p>Competing Projects:</p> |
| 108 | 116 | |
| 109 | 117 | <ul> |
| 110 | 118 |
| --- www/index.wiki | |
| +++ www/index.wiki | |
| @@ -4,15 +4,17 @@ | |
| 4 | Fossil is a new |
| 5 | <a href="http://en.wikipedia.org/wiki/Revision_control"> |
| 6 | distributed software revision control system</a> that includes an integrated |
| 7 | <a href="http://en.wikipedia.org/wiki/Wiki">Wiki</a> and an integrated |
| 8 | <a href="http://en.wikipedia.org/wiki/Bugtracker"> |
| 9 | bug-tracking system</a> all into a single easy-to-use stand-alone |
| 10 | executable. |
| 11 | (NB: The bug-tracker component is still not completely functional...) |
| 12 | Fossil is |
| 13 | <a href="http://www.fossil-scm.org/fossil/timeline">self-hosting</a> on |
| 14 | <a href="http://www.hwaci.com/cgi-bin/fossil/timeline">two separate servers</a>. |
| 15 | You can download the lastest sources |
| 16 | compile it yourself using the instructions below. |
| 17 | Or you can grab |
| 18 | <a href="http://www.fossil-scm.org/download.html">precompiled binaries</a>. |
| @@ -79,31 +81,37 @@ | |
| 79 | <a href="http://www.oreillynet.com/pub/a/oreilly/tim/news/2005/09/30/what-is-web-20.html">Web 2.0</a>. |
| 80 | Fossil attempts to better capture "collective intelligence" and |
| 81 | "the wisdom of crowds" by opening up write access to the masses.</li> |
| 82 | </ul> |
| 83 | |
| 84 | <p>Other Links:</p> |
| 85 | |
| 86 | <ul> |
| 87 | <li>The <a href="concepts.wiki">concepts</b> behind fossil</li> |
| 88 | <li><a href="build.wiki">Building And Installing</a></li> |
| 89 | <li><a href="quickstart.wiki">Quick Start</a> guide to using fossil |
| 90 | <li><a href="pop.wiki">Principles Of Operation</a></li> |
| 91 | <li>The <a href="selfcheck.wiki">automatic self-check</a> mechanism |
| 92 | helps insure project integrity.</li> |
| 93 | <li>The <a href="fileformat.wiki">file format</a> used by every content |
| 94 | file stored in the repository.</li> |
| 95 | <li>The <a href="delta_format.wiki">format of deltas</a> used to |
| 96 | efficiently store changes between file revisions.</li> |
| 97 | <li>The <a href="delta_encoder_algorithm.wiki">encoder algorithm</a> used to |
| 98 | efficiently generate deltas.</li> |
| 99 | <li>The <a href="sync.wiki">synchronization protocol</a>.</li> |
| 100 | <li>There is a <a href="http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users"> |
| 101 | mailing list</a> available for discussing fossil issues.</li> |
| 102 | <li>The <a href="http://www.fossil-scm.org/fossil/wiki">self-hosting |
| 103 | fossil wiki</a>, capable of hosting static pages and community-editable wiki |
| 104 | content.</li> |
| 105 | </ul> |
| 106 | |
| 107 | <p>Competing Projects:</p> |
| 108 | |
| 109 | <ul> |
| 110 |
| --- www/index.wiki | |
| +++ www/index.wiki | |
| @@ -4,15 +4,17 @@ | |
| 4 | Fossil is a new |
| 5 | <a href="http://en.wikipedia.org/wiki/Revision_control"> |
| 6 | distributed software revision control system</a> that includes an integrated |
| 7 | <a href="http://en.wikipedia.org/wiki/Wiki">Wiki</a> and an integrated |
| 8 | <a href="http://en.wikipedia.org/wiki/Bugtracker"> |
| 9 | bug-tracking system</a> all in a single easy-to-use stand-alone |
| 10 | executable. |
| 11 | (NB: The bug-tracker component is still not completely functional yet, but |
| 12 | we expect it to be available soon.) |
| 13 | Fossil is |
| 14 | <a href="http://www.fossil-scm.org/fossil/timeline">self-hosting</a> |
| 15 | since 2007-07-21 on |
| 16 | <a href="http://www.hwaci.com/cgi-bin/fossil/timeline">two separate servers</a>. |
| 17 | You can download the lastest sources |
| 18 | compile it yourself using the instructions below. |
| 19 | Or you can grab |
| 20 | <a href="http://www.fossil-scm.org/download.html">precompiled binaries</a>. |
| @@ -79,31 +81,37 @@ | |
| 81 | <a href="http://www.oreillynet.com/pub/a/oreilly/tim/news/2005/09/30/what-is-web-20.html">Web 2.0</a>. |
| 82 | Fossil attempts to better capture "collective intelligence" and |
| 83 | "the wisdom of crowds" by opening up write access to the masses.</li> |
| 84 | </ul> |
| 85 | |
| 86 | <p>User Links:</p> |
| 87 | |
| 88 | <ul> |
| 89 | <li>The <a href="concepts.wiki">concepts</b> behind fossil</li> |
| 90 | <li><a href="build.wiki">Building And Installing</a></li> |
| 91 | <li><a href="quickstart.wiki">Quick Start</a> guide to using fossil |
| 92 | <li>The <a href="selfcheck.wiki">automatic self-check</a> mechanism |
| 93 | helps insure project integrity.</li> |
| 94 | <li>The <a href="http://www.fossil-scm.org/fossil/wiki">self-hosting |
| 95 | fossil wiki</a>, capable of hosting static pages and community-editable wiki |
| 96 | content.</li> |
| 97 | <li>There is a |
| 98 | <a href="http://lists.fossil-scm.org:8080/cgi-bin/mailman/listinfo/fossil-users"> |
| 99 | mailing list</a> available for discussing fossil issues.</li> |
| 100 | </ul> |
| 101 | |
| 102 | <p>Developer Links: </p> |
| 103 | |
| 104 | <ul> |
| 105 | <li><a href="pop.wiki">Principles Of Operation</a></li> |
| 106 | <li>The <a href="fileformat.wiki">file format</a> used by every content |
| 107 | file stored in the repository.</li> |
| 108 | <li>The <a href="delta_format.wiki">format of deltas</a> used to |
| 109 | efficiently store changes between file revisions.</li> |
| 110 | <li>The <a href="delta_encoder_algorithm.wiki">encoder algorithm</a> used to |
| 111 | efficiently generate deltas.</li> |
| 112 | <li>The <a href="sync.wiki">synchronization protocol</a>.</li> |
| 113 | </ul> |
| 114 | |
| 115 | <p>Competing Projects:</p> |
| 116 | |
| 117 | <ul> |
| 118 |
+20
-12
| --- www/quickstart.wiki | ||
| +++ www/quickstart.wiki | ||
| @@ -50,17 +50,21 @@ | ||
| 50 | 50 | project or create a new project of your own, you usually want to do some |
| 51 | 51 | local configuration. This is accomplished using a webbrowser. First |
| 52 | 52 | start a fossil webserver like this:</p> |
| 53 | 53 | |
| 54 | 54 | <blockquote> |
| 55 | - <b>fossil server </b><i> repository-filename</i> | |
| 55 | + <b>fossil ui </b><i> repository-filename</i> | |
| 56 | 56 | </blockquote> |
| 57 | 57 | |
| 58 | 58 | <p>This creates a mini-webserver listening on port 8080. You can |
| 59 | 59 | specify a different port using the <b>-port</b> option on the command-line. |
| 60 | - After the server is running, point your webbrowser at | |
| 61 | - http://localhost:8080/ and start configuring.</p> | |
| 60 | + After the server is running, fossil will then attempt to launch your | |
| 61 | + web browser and make it point to this web server. If your system | |
| 62 | + has an unusual configuration, fossil might not be able to figure out | |
| 63 | + how to start your web browser. In that case, start the web browser | |
| 64 | + yourself and point it at http://localhost:8080/. Click on the | |
| 65 | + "Setup" link on the menu bar to start configuring your repository.</p> | |
| 62 | 66 | |
| 63 | 67 | <p>By default, fossil does not require a login for HTTP connections |
| 64 | 68 | coming in from the IP loopback address 127.0.0.1. You can, and perhaps |
| 65 | 69 | should, change this after you create a few users.</p> |
| 66 | 70 | |
| @@ -76,18 +80,13 @@ | ||
| 76 | 80 | |
| 77 | 81 | <blockquote> |
| 78 | 82 | <b>fossil open </b><i> repository-filename</i> |
| 79 | 83 | </blockquote> |
| 80 | 84 | |
| 81 | - <p>This leaves you with the original (empty) version of the tree | |
| 82 | - checked out. To get to the latest version, also do this:</p> | |
| 83 | - | |
| 84 | - <blockquote> | |
| 85 | - <b>fossil update</b> | |
| 86 | - </blockquote> | |
| 87 | - | |
| 88 | - <p>From anywhere underneath the root of your local tree, you | |
| 85 | + <p>This leaves you with the newest version of the tree | |
| 86 | + checked out. | |
| 87 | + From anywhere underneath the root of your local tree, you | |
| 89 | 88 | can type commands like the following to find out the status of |
| 90 | 89 | your local tree:</p> |
| 91 | 90 | |
| 92 | 91 | <blockquote> |
| 93 | 92 | <b>fossil info</b><br> |
| @@ -182,11 +181,20 @@ | ||
| 182 | 181 | |
| 183 | 182 | <blockquote> |
| 184 | 183 | <b>fossil server</b> <i>repository-filename</i> |
| 185 | 184 | </blockquote> |
| 186 | 185 | |
| 187 | - <p>You can omit the <i>repository-filename</i> if you are within | |
| 186 | + <p>Or</b> | |
| 187 | + | |
| 188 | + <blockquote> | |
| 189 | + <b>fossil ui</b> <i>repository-filename</i> | |
| 190 | + </blockquote> | |
| 191 | + | |
| 192 | + <p>The difference between these two command is that <b>ui</b> | |
| 193 | + attempts to automatically start your web browser point at the | |
| 194 | + server whereas <b>server</b> does not. | |
| 195 | + You can omit the <i>repository-filename</i> if you are within | |
| 188 | 196 | a checked-out local tree. This server uses port 8080 by default |
| 189 | 197 | but you can specify a different port using the <b>-port</b> command.</p> |
| 190 | 198 | |
| 191 | 199 | <p>Command-line servers like this are useful when two people want |
| 192 | 200 | to share a repository on temporary or ad-hoc basis. For a more |
| 193 | 201 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -50,17 +50,21 @@ | |
| 50 | project or create a new project of your own, you usually want to do some |
| 51 | local configuration. This is accomplished using a webbrowser. First |
| 52 | start a fossil webserver like this:</p> |
| 53 | |
| 54 | <blockquote> |
| 55 | <b>fossil server </b><i> repository-filename</i> |
| 56 | </blockquote> |
| 57 | |
| 58 | <p>This creates a mini-webserver listening on port 8080. You can |
| 59 | specify a different port using the <b>-port</b> option on the command-line. |
| 60 | After the server is running, point your webbrowser at |
| 61 | http://localhost:8080/ and start configuring.</p> |
| 62 | |
| 63 | <p>By default, fossil does not require a login for HTTP connections |
| 64 | coming in from the IP loopback address 127.0.0.1. You can, and perhaps |
| 65 | should, change this after you create a few users.</p> |
| 66 | |
| @@ -76,18 +80,13 @@ | |
| 76 | |
| 77 | <blockquote> |
| 78 | <b>fossil open </b><i> repository-filename</i> |
| 79 | </blockquote> |
| 80 | |
| 81 | <p>This leaves you with the original (empty) version of the tree |
| 82 | checked out. To get to the latest version, also do this:</p> |
| 83 | |
| 84 | <blockquote> |
| 85 | <b>fossil update</b> |
| 86 | </blockquote> |
| 87 | |
| 88 | <p>From anywhere underneath the root of your local tree, you |
| 89 | can type commands like the following to find out the status of |
| 90 | your local tree:</p> |
| 91 | |
| 92 | <blockquote> |
| 93 | <b>fossil info</b><br> |
| @@ -182,11 +181,20 @@ | |
| 182 | |
| 183 | <blockquote> |
| 184 | <b>fossil server</b> <i>repository-filename</i> |
| 185 | </blockquote> |
| 186 | |
| 187 | <p>You can omit the <i>repository-filename</i> if you are within |
| 188 | a checked-out local tree. This server uses port 8080 by default |
| 189 | but you can specify a different port using the <b>-port</b> command.</p> |
| 190 | |
| 191 | <p>Command-line servers like this are useful when two people want |
| 192 | to share a repository on temporary or ad-hoc basis. For a more |
| 193 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -50,17 +50,21 @@ | |
| 50 | project or create a new project of your own, you usually want to do some |
| 51 | local configuration. This is accomplished using a webbrowser. First |
| 52 | start a fossil webserver like this:</p> |
| 53 | |
| 54 | <blockquote> |
| 55 | <b>fossil ui </b><i> repository-filename</i> |
| 56 | </blockquote> |
| 57 | |
| 58 | <p>This creates a mini-webserver listening on port 8080. You can |
| 59 | specify a different port using the <b>-port</b> option on the command-line. |
| 60 | After the server is running, fossil will then attempt to launch your |
| 61 | web browser and make it point to this web server. If your system |
| 62 | has an unusual configuration, fossil might not be able to figure out |
| 63 | how to start your web browser. In that case, start the web browser |
| 64 | yourself and point it at http://localhost:8080/. Click on the |
| 65 | "Setup" link on the menu bar to start configuring your repository.</p> |
| 66 | |
| 67 | <p>By default, fossil does not require a login for HTTP connections |
| 68 | coming in from the IP loopback address 127.0.0.1. You can, and perhaps |
| 69 | should, change this after you create a few users.</p> |
| 70 | |
| @@ -76,18 +80,13 @@ | |
| 80 | |
| 81 | <blockquote> |
| 82 | <b>fossil open </b><i> repository-filename</i> |
| 83 | </blockquote> |
| 84 | |
| 85 | <p>This leaves you with the newest version of the tree |
| 86 | checked out. |
| 87 | From anywhere underneath the root of your local tree, you |
| 88 | can type commands like the following to find out the status of |
| 89 | your local tree:</p> |
| 90 | |
| 91 | <blockquote> |
| 92 | <b>fossil info</b><br> |
| @@ -182,11 +181,20 @@ | |
| 181 | |
| 182 | <blockquote> |
| 183 | <b>fossil server</b> <i>repository-filename</i> |
| 184 | </blockquote> |
| 185 | |
| 186 | <p>Or</b> |
| 187 | |
| 188 | <blockquote> |
| 189 | <b>fossil ui</b> <i>repository-filename</i> |
| 190 | </blockquote> |
| 191 | |
| 192 | <p>The difference between these two command is that <b>ui</b> |
| 193 | attempts to automatically start your web browser point at the |
| 194 | server whereas <b>server</b> does not. |
| 195 | You can omit the <i>repository-filename</i> if you are within |
| 196 | a checked-out local tree. This server uses port 8080 by default |
| 197 | but you can specify a different port using the <b>-port</b> command.</p> |
| 198 | |
| 199 | <p>Command-line servers like this are useful when two people want |
| 200 | to share a repository on temporary or ad-hoc basis. For a more |
| 201 |