Fossil SCM

Updates to the quick-start page.

drh 2012-09-19 11:32 trunk
Commit 2e9691055efd0021e9618b4953b4b9833962d51b
1 file changed +20 -4
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -70,17 +70,17 @@
7070
which in the example above is named "myclone.fossil".
7171
You can name your repositories anything you want. The ".fossil" suffix
7272
is not required.</p>
7373
7474
<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>
75
+ to <a href="#proxy">specify an HTTP proxy</a>.</p>
7676
7777
<p>A Fossil repository is a single disk file. Instead of cloning,
7878
you can just make a copy of the repository file (for example, using
7979
"scp"). Note, however, that the repository file contains auxiliary
8080
information above and beyond the versioned files, including some
81
- sensitive information such as passwords and email addresses. If you
81
+ sensitive information such as password hashs and email addresses. If you
8282
want to share Fossil repositories directly, consider running the
8383
[/help/scrub|fossil scrub] command to remove sensitive information
8484
before transmitting the file.
8585
8686
<h2>Importing From Another Version Control System</h2>
@@ -114,10 +114,15 @@
114114
<b>[/help/diff | fossil diff]</b><br>
115115
<b>[/help/timeline | fossil timeline]</b><br>
116116
<b>[/help/ls | fossil ls]</b><br>
117117
<b>[/help/branch | fossil branch]</b><br>
118118
</blockquote>
119
+
120
+ <p>Note that Fossil allows you to make multiple check-outs in
121
+ separate directories from the same repository. This enables you,
122
+ for example, to do builds from multiple branches or versions at
123
+ the same time without having to generate extra clones.</p>
119124
120125
<h2>Configuring Your Local Repository</h2>
121126
122127
<p>When you create a new repository, either by cloning an existing
123128
project or create a new project of your own, you usually want to do some
@@ -209,12 +214,18 @@
209214
the <i>VERSION</i>, then fossil moves you to the
210215
latest version of the branch your are currently on.</p>
211216
212217
<h2>Branching And Merging</h2>
213218
214
- <p>You can create branches by doing multiple commits off of the
215
- same base version. To merge two branches back together, first
219
+ <p>Use the --branch option to the [/help/commit | commit] command
220
+ to start a new branch. Note that in Fossil, branches are normally
221
+ created when you commit, not before you start editing. You can
222
+ use the [/help/branch | branch new] command to create a new branch
223
+ before you start editing, if you want, but most people just wait
224
+ until they are ready to commit.
225
+
226
+ To merge two branches back together, first
216227
[/help/update | update] to the leaf of one branch. Then do a
217228
[/help/merge | merge] of the leaf of the other branch:</p>
218229
219230
<blockquote>
220231
<b>[/help/merge | fossil merge]</b> <i>VERSION</i>
@@ -232,10 +243,15 @@
232243
Remember that your coworkers can not see your changes until you
233244
commit and push them.</p>
234245
235246
<p>The merge command has options to cherrypick individual
236247
changes, or to back out individual changes.</p>
248
+
249
+ <p>Note that the merge command changes only your local check-out.
250
+ The merge command does <em>not</em> modify the repository in any way.
251
+ You must do a separate [/help/commit | commit] after the merge in order
252
+ to put the merged code back into the repository.</p>
237253
238254
<p>If a merge or update doesn't work out (perhaps something breaks or
239255
there are many merge conflicts) then you back up using:</p>
240256
241257
<blockquote>
242258
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -70,17 +70,17 @@
70 which in the example above is named "myclone.fossil".
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>
@@ -114,10 +114,15 @@
114 <b>[/help/diff | fossil diff]</b><br>
115 <b>[/help/timeline | fossil timeline]</b><br>
116 <b>[/help/ls | fossil ls]</b><br>
117 <b>[/help/branch | fossil branch]</b><br>
118 </blockquote>
 
 
 
 
 
119
120 <h2>Configuring Your Local Repository</h2>
121
122 <p>When you create a new repository, either by cloning an existing
123 project or create a new project of your own, you usually want to do some
@@ -209,12 +214,18 @@
209 the <i>VERSION</i>, then fossil moves you to the
210 latest version of the branch your are currently on.</p>
211
212 <h2>Branching And Merging</h2>
213
214 <p>You can create branches by doing multiple commits off of the
215 same base version. To merge two branches back together, first
 
 
 
 
 
 
216 [/help/update | update] to the leaf of one branch. Then do a
217 [/help/merge | merge] of the leaf of the other branch:</p>
218
219 <blockquote>
220 <b>[/help/merge | fossil merge]</b> <i>VERSION</i>
@@ -232,10 +243,15 @@
232 Remember that your coworkers can not see your changes until you
233 commit and push them.</p>
234
235 <p>The merge command has options to cherrypick individual
236 changes, or to back out individual changes.</p>
 
 
 
 
 
237
238 <p>If a merge or update doesn't work out (perhaps something breaks or
239 there are many merge conflicts) then you back up using:</p>
240
241 <blockquote>
242
--- www/quickstart.wiki
+++ www/quickstart.wiki
@@ -70,17 +70,17 @@
70 which in the example above is named "myclone.fossil".
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>.</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 password hashs 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>
@@ -114,10 +114,15 @@
114 <b>[/help/diff | fossil diff]</b><br>
115 <b>[/help/timeline | fossil timeline]</b><br>
116 <b>[/help/ls | fossil ls]</b><br>
117 <b>[/help/branch | fossil branch]</b><br>
118 </blockquote>
119
120 <p>Note that Fossil allows you to make multiple check-outs in
121 separate directories from the same repository. This enables you,
122 for example, to do builds from multiple branches or versions at
123 the same time without having to generate extra clones.</p>
124
125 <h2>Configuring Your Local Repository</h2>
126
127 <p>When you create a new repository, either by cloning an existing
128 project or create a new project of your own, you usually want to do some
@@ -209,12 +214,18 @@
214 the <i>VERSION</i>, then fossil moves you to the
215 latest version of the branch your are currently on.</p>
216
217 <h2>Branching And Merging</h2>
218
219 <p>Use the --branch option to the [/help/commit | commit] command
220 to start a new branch. Note that in Fossil, branches are normally
221 created when you commit, not before you start editing. You can
222 use the [/help/branch | branch new] command to create a new branch
223 before you start editing, if you want, but most people just wait
224 until they are ready to commit.
225
226 To merge two branches back together, first
227 [/help/update | update] to the leaf of one branch. Then do a
228 [/help/merge | merge] of the leaf of the other branch:</p>
229
230 <blockquote>
231 <b>[/help/merge | fossil merge]</b> <i>VERSION</i>
@@ -232,10 +243,15 @@
243 Remember that your coworkers can not see your changes until you
244 commit and push them.</p>
245
246 <p>The merge command has options to cherrypick individual
247 changes, or to back out individual changes.</p>
248
249 <p>Note that the merge command changes only your local check-out.
250 The merge command does <em>not</em> modify the repository in any way.
251 You must do a separate [/help/commit | commit] after the merge in order
252 to put the merged code back into the repository.</p>
253
254 <p>If a merge or update doesn't work out (perhaps something breaks or
255 there are many merge conflicts) then you back up using:</p>
256
257 <blockquote>
258

Keyboard Shortcuts

Open search /
Next entry (timeline) j
Previous entry (timeline) k
Open focused entry Enter
Show this help ?
Toggle theme Top nav button