Fossil SCM
Updates to the "Quick Start" documentation.
Commit
a8f271e81e77f56802e88426fbb6acde7868fe38
Parent
a992b276e198210…
1 file changed
+15
-7
+15
-7
| --- www/quickstart.wiki | ||
| +++ www/quickstart.wiki | ||
| @@ -9,11 +9,11 @@ | ||
| 9 | 9 | <p>Fossil is a single self-contained C program. You need to |
| 10 | 10 | either download a |
| 11 | 11 | <a href="http://www.fossil-scm.org/download.html">precompiled binary</a> |
| 12 | 12 | or <a href="build.wiki">build it yourself</a> from sources. |
| 13 | 13 | Install fossil by putting the fossil binary |
| 14 | - someplace on your PATH environment variable.</p> | |
| 14 | + someplace on your $PATH.</p> | |
| 15 | 15 | |
| 16 | 16 | <a name="fslclone"></a> |
| 17 | 17 | <h2>General Work Flow</h2> |
| 18 | 18 | |
| 19 | 19 | <p>Fossil works with repository files (a database with the project's |
| @@ -20,29 +20,27 @@ | ||
| 20 | 20 | complete history) and with checked-out local trees (the working directory |
| 21 | 21 | you use to do your work). |
| 22 | 22 | The workflow looks like this:</p> |
| 23 | 23 | |
| 24 | 24 | <ul> |
| 25 | - <li>Create or clone a repository file. ([/help/new|fossil new] or | |
| 25 | + <li>Create or clone a repository file. ([/help/init|fossil init] or | |
| 26 | 26 | [/help/clone | fossil clone]) |
| 27 | 27 | <li>Check out a local tree. ([/help/open | fossil open]) |
| 28 | 28 | <li>Perform operations on the repository (including repository |
| 29 | 29 | configuration). |
| 30 | - <li><em>Optionally</em> close the local tree. | |
| 31 | - ([/help/close | fossil close], but this is rarely used.) | |
| 32 | 30 | </ul> |
| 33 | 31 | |
| 34 | 32 | <p>The following sections will give you a brief overview of these |
| 35 | 33 | operations.</p> |
| 36 | 34 | |
| 37 | 35 | <h2>Starting A New Project</h2> |
| 38 | 36 | |
| 39 | 37 | <p>To start a new project with fossil, create a new empty repository |
| 40 | - this way: ([/help/new | more info]) </p> | |
| 38 | + this way: ([/help/init | more info]) </p> | |
| 41 | 39 | |
| 42 | 40 | <blockquote> |
| 43 | - <b>fossil new </b><i> repository-filename</i> | |
| 41 | + <b>fossil init </b><i> repository-filename</i> | |
| 44 | 42 | </blockquote> |
| 45 | 43 | |
| 46 | 44 | <h2>Cloning An Existing Repository</h2> |
| 47 | 45 | |
| 48 | 46 | <p>Most fossil operations interact with a repository that is on the |
| @@ -73,10 +71,19 @@ | ||
| 73 | 71 | You can name your repositories anything you want. The ".fossil" suffix |
| 74 | 72 | is not required.</p> |
| 75 | 73 | |
| 76 | 74 | <p>Note: If you are behind a restrictive firewall, you might need |
| 77 | 75 | to <a href="#proxy">specify an HTTP proxy</a> to use.</p> |
| 76 | + | |
| 77 | + <p>A Fossil repository is a single disk file. Instead of cloning, | |
| 78 | + you can just make a copy of the repository file (for example, using | |
| 79 | + "scp"). Note, however, that the repository file contains auxiliary | |
| 80 | + information above and beyond the versioned files, including some | |
| 81 | + sensitive information such as passwords and email addresses. If you | |
| 82 | + want to share Fossil repositories directly, consider running the | |
| 83 | + [/help/scrub|fossil scrub] command to remove sensitive information | |
| 84 | + before transmitting the file. | |
| 78 | 85 | |
| 79 | 86 | <h2>Importing From Another Version Control System</h2> |
| 80 | 87 | |
| 81 | 88 | <p>Rather than start a new project, or clone an existing Fossil project, |
| 82 | 89 | you might prefer to |
| @@ -147,11 +154,12 @@ | ||
| 147 | 154 | <p>To add new files to your project, or remove old files, use these |
| 148 | 155 | commands:</p> |
| 149 | 156 | |
| 150 | 157 | <blockquote> |
| 151 | 158 | <b>[/help/add | fossil add]</b> <i>file...</i><br> |
| 152 | - <b>[/help/rm | fossil rm]</b> <i>file...</i> | |
| 159 | + <b>[/help/rm | fossil rm]</b> <i>file...</i><br> | |
| 160 | + <b>[/help/addremove | fossil addremove]</b> <i>file...</i><br> | |
| 153 | 161 | </blockquote> |
| 154 | 162 | |
| 155 | 163 | <p>You can also edit files freely. Once you are ready to commit |
| 156 | 164 | your changes, type:</p> |
| 157 | 165 | |
| 158 | 166 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -9,11 +9,11 @@ | |
| 9 | <p>Fossil is a single self-contained C program. You need to |
| 10 | either download a |
| 11 | <a href="http://www.fossil-scm.org/download.html">precompiled binary</a> |
| 12 | or <a href="build.wiki">build it yourself</a> from sources. |
| 13 | Install fossil by putting the fossil binary |
| 14 | someplace on your PATH environment variable.</p> |
| 15 | |
| 16 | <a name="fslclone"></a> |
| 17 | <h2>General Work Flow</h2> |
| 18 | |
| 19 | <p>Fossil works with repository files (a database with the project's |
| @@ -20,29 +20,27 @@ | |
| 20 | complete history) and with checked-out local trees (the working directory |
| 21 | you use to do your work). |
| 22 | The workflow looks like this:</p> |
| 23 | |
| 24 | <ul> |
| 25 | <li>Create or clone a repository file. ([/help/new|fossil new] or |
| 26 | [/help/clone | fossil clone]) |
| 27 | <li>Check out a local tree. ([/help/open | fossil open]) |
| 28 | <li>Perform operations on the repository (including repository |
| 29 | configuration). |
| 30 | <li><em>Optionally</em> close the local tree. |
| 31 | ([/help/close | fossil close], but this is rarely used.) |
| 32 | </ul> |
| 33 | |
| 34 | <p>The following sections will give you a brief overview of these |
| 35 | operations.</p> |
| 36 | |
| 37 | <h2>Starting A New Project</h2> |
| 38 | |
| 39 | <p>To start a new project with fossil, create a new empty repository |
| 40 | this way: ([/help/new | more info]) </p> |
| 41 | |
| 42 | <blockquote> |
| 43 | <b>fossil new </b><i> repository-filename</i> |
| 44 | </blockquote> |
| 45 | |
| 46 | <h2>Cloning An Existing Repository</h2> |
| 47 | |
| 48 | <p>Most fossil operations interact with a repository that is on the |
| @@ -73,10 +71,19 @@ | |
| 73 | You can name your repositories anything you want. The ".fossil" suffix |
| 74 | is not required.</p> |
| 75 | |
| 76 | <p>Note: If you are behind a restrictive firewall, you might need |
| 77 | to <a href="#proxy">specify an HTTP proxy</a> to use.</p> |
| 78 | |
| 79 | <h2>Importing From Another Version Control System</h2> |
| 80 | |
| 81 | <p>Rather than start a new project, or clone an existing Fossil project, |
| 82 | you might prefer to |
| @@ -147,11 +154,12 @@ | |
| 147 | <p>To add new files to your project, or remove old files, use these |
| 148 | commands:</p> |
| 149 | |
| 150 | <blockquote> |
| 151 | <b>[/help/add | fossil add]</b> <i>file...</i><br> |
| 152 | <b>[/help/rm | fossil rm]</b> <i>file...</i> |
| 153 | </blockquote> |
| 154 | |
| 155 | <p>You can also edit files freely. Once you are ready to commit |
| 156 | your changes, type:</p> |
| 157 | |
| 158 |
| --- www/quickstart.wiki | |
| +++ www/quickstart.wiki | |
| @@ -9,11 +9,11 @@ | |
| 9 | <p>Fossil is a single self-contained C program. You need to |
| 10 | either download a |
| 11 | <a href="http://www.fossil-scm.org/download.html">precompiled binary</a> |
| 12 | or <a href="build.wiki">build it yourself</a> from sources. |
| 13 | Install fossil by putting the fossil binary |
| 14 | someplace on your $PATH.</p> |
| 15 | |
| 16 | <a name="fslclone"></a> |
| 17 | <h2>General Work Flow</h2> |
| 18 | |
| 19 | <p>Fossil works with repository files (a database with the project's |
| @@ -20,29 +20,27 @@ | |
| 20 | complete history) and with checked-out local trees (the working directory |
| 21 | you use to do your work). |
| 22 | The workflow looks like this:</p> |
| 23 | |
| 24 | <ul> |
| 25 | <li>Create or clone a repository file. ([/help/init|fossil init] or |
| 26 | [/help/clone | fossil clone]) |
| 27 | <li>Check out a local tree. ([/help/open | fossil open]) |
| 28 | <li>Perform operations on the repository (including repository |
| 29 | configuration). |
| 30 | </ul> |
| 31 | |
| 32 | <p>The following sections will give you a brief overview of these |
| 33 | operations.</p> |
| 34 | |
| 35 | <h2>Starting A New Project</h2> |
| 36 | |
| 37 | <p>To start a new project with fossil, create a new empty repository |
| 38 | this way: ([/help/init | more info]) </p> |
| 39 | |
| 40 | <blockquote> |
| 41 | <b>fossil init </b><i> repository-filename</i> |
| 42 | </blockquote> |
| 43 | |
| 44 | <h2>Cloning An Existing Repository</h2> |
| 45 | |
| 46 | <p>Most fossil operations interact with a repository that is on the |
| @@ -73,10 +71,19 @@ | |
| 71 | You can name your repositories anything you want. The ".fossil" suffix |
| 72 | is not required.</p> |
| 73 | |
| 74 | <p>Note: If you are behind a restrictive firewall, you might need |
| 75 | to <a href="#proxy">specify an HTTP proxy</a> to use.</p> |
| 76 | |
| 77 | <p>A Fossil repository is a single disk file. Instead of cloning, |
| 78 | you can just make a copy of the repository file (for example, using |
| 79 | "scp"). Note, however, that the repository file contains auxiliary |
| 80 | information above and beyond the versioned files, including some |
| 81 | sensitive information such as passwords and email addresses. If you |
| 82 | want to share Fossil repositories directly, consider running the |
| 83 | [/help/scrub|fossil scrub] command to remove sensitive information |
| 84 | before transmitting the file. |
| 85 | |
| 86 | <h2>Importing From Another Version Control System</h2> |
| 87 | |
| 88 | <p>Rather than start a new project, or clone an existing Fossil project, |
| 89 | you might prefer to |
| @@ -147,11 +154,12 @@ | |
| 154 | <p>To add new files to your project, or remove old files, use these |
| 155 | commands:</p> |
| 156 | |
| 157 | <blockquote> |
| 158 | <b>[/help/add | fossil add]</b> <i>file...</i><br> |
| 159 | <b>[/help/rm | fossil rm]</b> <i>file...</i><br> |
| 160 | <b>[/help/addremove | fossil addremove]</b> <i>file...</i><br> |
| 161 | </blockquote> |
| 162 | |
| 163 | <p>You can also edit files freely. Once you are ready to commit |
| 164 | your changes, type:</p> |
| 165 | |
| 166 |