Fossil SCM

Merge documentation updates from the msw-docco branch into trunk.

drh 2011-09-14 11:14 trunk merge
Commit 2210be19cc6c9b5d82e02d1a6f55c56bc21bed68
Parent 9caa3506c54fac0…
17 files changed +16 -7 +5 -3 +49 -41 +13 -3 +4 -4 +4 -4 +6 -1 -1 +9 -5 +10 -2 +1 -1 +7 -1 +8 -1 +16 -4 +6 -1 +1 -1 +22 -11
~ src/add.c ~ src/branch.c ~ src/checkin.c ~ src/checkout.c ~ src/clone.c ~ src/clone.c ~ src/configure.c ~ src/content.c ~ src/db.c ~ src/descendants.c ~ src/diff.c ~ src/diffcmd.c ~ src/export.c ~ src/finfo.c ~ src/import.c ~ src/merge.c ~ src/rebuild.c
M src/add.c
+16 -7
--- src/add.c
+++ src/add.c
@@ -181,12 +181,17 @@
181181
 ** The --ignore option is a comma-separate list of glob patterns for files
182182
 ** to be excluded. Example: '*.o,*.obj,*.exe' If the --ignore option
183183
 ** does not appear on the command line then the "ignore-glob" setting is
184184
 ** used.
185185
 **
186
-** SUMMARY: fossil add ?OPTIONS? FILE1 ?FILE2 ...?
187
-** Options: --dotfiles, --ignore
186
+** Options:
187
+**
188
+** --dotfiles include files beginning with a dot (".")
189
+** --ignore <CSG> ignore files matching patterns from the
190
+** comma separated list of glob patterns.
191
+**
192
+** See also: addremove, rm
188193
 */
189194
 void add_cmd(void){
190195
 int i; /* Loop counter */
191196
 int vid; /* Currently checked out version */
192197
 int nRoot; /* Full path characters in g.zLocalRoot */
@@ -259,12 +264,11 @@
259264
 **
260265
 ** This command does NOT remove the files from disk. It just marks the
261266
 ** files as no longer being part of the project. In other words, future
262267
 ** changes to the named files will not be versioned.
263268
 **
264
-** SUMMARY: fossil rm FILE1 ?FILE2 ...?
265
-** or: fossil delete FILE1 ?FILE2 ...?
269
+** See also: addremove, add
266270
 */
267271
 void delete_cmd(void){
268272
 int i;
269273
 int vid;
270274
 Stmt loop;
@@ -344,11 +348,11 @@
344348
 }
345349
346350
 /*
347351
 ** COMMAND: addremove
348352
 **
349
-** Usage: %fossil addremove ?--dotfiles? ?--ignore GLOBPATTERN? ?--test?
353
+** Usage: %fossil addremove ?OPTIONS?
350354
 **
351355
 ** Do all necessary "add" and "rm" commands to synchronize the repository
352356
 ** with the content of the working checkout:
353357
 **
354358
 ** * All files in the checkout but not in the repository (that is,
@@ -369,13 +373,18 @@
369373
 ** documentation on the "settings" command for further information.
370374
 **
371375
 ** The --test option shows what would happen without actually doing anything.
372376
 **
373377
 ** This command can be used to track third party software.
378
+**
379
+** Options:
380
+** --dotfiles include files beginning with a dot (".")
381
+** --ignore <CSG> ignore files matching patterns from the
382
+** comma separated list of glob patterns.
383
+** --test If given, show what would be done without doing so.
374384
 **
375
-** SUMMARY: fossil addremove
376
-** Options: ?--dotfiles? ?--ignore GLOB? ?--test? ?--case-sensitive BOOL?
385
+** See also: add, rm
377386
 */
378387
 void addremove_cmd(void){
379388
 Blob path;
380389
 const char *zIgnoreFlag = find_option("ignore",0,1);
381390
 int allFlag = find_option("dotfiles",0,0)!=0;
382391
--- src/add.c
+++ src/add.c
@@ -181,12 +181,17 @@
181 ** The --ignore option is a comma-separate list of glob patterns for files
182 ** to be excluded. Example: '*.o,*.obj,*.exe' If the --ignore option
183 ** does not appear on the command line then the "ignore-glob" setting is
184 ** used.
185 **
186 ** SUMMARY: fossil add ?OPTIONS? FILE1 ?FILE2 ...?
187 ** Options: --dotfiles, --ignore
 
 
 
 
 
188 */
189 void add_cmd(void){
190 int i; /* Loop counter */
191 int vid; /* Currently checked out version */
192 int nRoot; /* Full path characters in g.zLocalRoot */
@@ -259,12 +264,11 @@
259 **
260 ** This command does NOT remove the files from disk. It just marks the
261 ** files as no longer being part of the project. In other words, future
262 ** changes to the named files will not be versioned.
263 **
264 ** SUMMARY: fossil rm FILE1 ?FILE2 ...?
265 ** or: fossil delete FILE1 ?FILE2 ...?
266 */
267 void delete_cmd(void){
268 int i;
269 int vid;
270 Stmt loop;
@@ -344,11 +348,11 @@
344 }
345
346 /*
347 ** COMMAND: addremove
348 **
349 ** Usage: %fossil addremove ?--dotfiles? ?--ignore GLOBPATTERN? ?--test?
350 **
351 ** Do all necessary "add" and "rm" commands to synchronize the repository
352 ** with the content of the working checkout:
353 **
354 ** * All files in the checkout but not in the repository (that is,
@@ -369,13 +373,18 @@
369 ** documentation on the "settings" command for further information.
370 **
371 ** The --test option shows what would happen without actually doing anything.
372 **
373 ** This command can be used to track third party software.
 
 
 
 
 
 
374 **
375 ** SUMMARY: fossil addremove
376 ** Options: ?--dotfiles? ?--ignore GLOB? ?--test? ?--case-sensitive BOOL?
377 */
378 void addremove_cmd(void){
379 Blob path;
380 const char *zIgnoreFlag = find_option("ignore",0,1);
381 int allFlag = find_option("dotfiles",0,0)!=0;
382
--- src/add.c
+++ src/add.c
@@ -181,12 +181,17 @@
181 ** The --ignore option is a comma-separate list of glob patterns for files
182 ** to be excluded. Example: '*.o,*.obj,*.exe' If the --ignore option
183 ** does not appear on the command line then the "ignore-glob" setting is
184 ** used.
185 **
186 ** Options:
187 **
188 ** --dotfiles include files beginning with a dot (".")
189 ** --ignore <CSG> ignore files matching patterns from the
190 ** comma separated list of glob patterns.
191 **
192 ** See also: addremove, rm
193 */
194 void add_cmd(void){
195 int i; /* Loop counter */
196 int vid; /* Currently checked out version */
197 int nRoot; /* Full path characters in g.zLocalRoot */
@@ -259,12 +264,11 @@
264 **
265 ** This command does NOT remove the files from disk. It just marks the
266 ** files as no longer being part of the project. In other words, future
267 ** changes to the named files will not be versioned.
268 **
269 ** See also: addremove, add
 
270 */
271 void delete_cmd(void){
272 int i;
273 int vid;
274 Stmt loop;
@@ -344,11 +348,11 @@
348 }
349
350 /*
351 ** COMMAND: addremove
352 **
353 ** Usage: %fossil addremove ?OPTIONS?
354 **
355 ** Do all necessary "add" and "rm" commands to synchronize the repository
356 ** with the content of the working checkout:
357 **
358 ** * All files in the checkout but not in the repository (that is,
@@ -369,13 +373,18 @@
373 ** documentation on the "settings" command for further information.
374 **
375 ** The --test option shows what would happen without actually doing anything.
376 **
377 ** This command can be used to track third party software.
378 **
379 ** Options:
380 ** --dotfiles include files beginning with a dot (".")
381 ** --ignore <CSG> ignore files matching patterns from the
382 ** comma separated list of glob patterns.
383 ** --test If given, show what would be done without doing so.
384 **
385 ** See also: add, rm
 
386 */
387 void addremove_cmd(void){
388 Blob path;
389 const char *zIgnoreFlag = find_option("ignore",0,1);
390 int allFlag = find_option("dotfiles",0,0)!=0;
391
M src/branch.c
+5 -3
--- src/branch.c
+++ src/branch.c
@@ -217,11 +217,11 @@
217217
218218
219219
 /*
220220
 ** COMMAND: branch
221221
 **
222
-** Usage: %fossil branch SUBCOMMAND ... ?-R|--repository FILE?
222
+** Usage: %fossil branch SUBCOMMAND ... ?OPTIONS?
223223
 **
224224
 ** Run various subcommands to manage branches of the open repository or
225225
 ** of the repository identified by the -R or --repository option.
226226
 **
227227
 ** %fossil branch new BRANCH-NAME BASIS ?--bgcolor COLOR? ?--private?
@@ -228,16 +228,18 @@
228228
 **
229229
 ** Create a new branch BRANCH-NAME off of check-in BASIS.
230230
 ** You can optionally give the branch a default color. The
231231
 ** --private option makes the branch private.
232232
 **
233
-** %fossil branch list
234
-** %fossil branch ls
233
+** %fossil branch list ?-all | --closed?
234
+** %fossil branch ls ?-all | --closed?
235235
 **
236236
 ** List all branches. Use --all or --closed to list all branches
237237
 ** or closed branches. The default is to show only open branches.
238238
 **
239
+** Options:
240
+** -R|--repository FILE Run commands on repository FILE
239241
 */
240242
 void branch_cmd(void){
241243
 int n;
242244
 const char *zCmd = "list";
243245
 db_find_and_open_repository(0, 0);
244246
--- src/branch.c
+++ src/branch.c
@@ -217,11 +217,11 @@
217
218
219 /*
220 ** COMMAND: branch
221 **
222 ** Usage: %fossil branch SUBCOMMAND ... ?-R|--repository FILE?
223 **
224 ** Run various subcommands to manage branches of the open repository or
225 ** of the repository identified by the -R or --repository option.
226 **
227 ** %fossil branch new BRANCH-NAME BASIS ?--bgcolor COLOR? ?--private?
@@ -228,16 +228,18 @@
228 **
229 ** Create a new branch BRANCH-NAME off of check-in BASIS.
230 ** You can optionally give the branch a default color. The
231 ** --private option makes the branch private.
232 **
233 ** %fossil branch list
234 ** %fossil branch ls
235 **
236 ** List all branches. Use --all or --closed to list all branches
237 ** or closed branches. The default is to show only open branches.
238 **
 
 
239 */
240 void branch_cmd(void){
241 int n;
242 const char *zCmd = "list";
243 db_find_and_open_repository(0, 0);
244
--- src/branch.c
+++ src/branch.c
@@ -217,11 +217,11 @@
217
218
219 /*
220 ** COMMAND: branch
221 **
222 ** Usage: %fossil branch SUBCOMMAND ... ?OPTIONS?
223 **
224 ** Run various subcommands to manage branches of the open repository or
225 ** of the repository identified by the -R or --repository option.
226 **
227 ** %fossil branch new BRANCH-NAME BASIS ?--bgcolor COLOR? ?--private?
@@ -228,16 +228,18 @@
228 **
229 ** Create a new branch BRANCH-NAME off of check-in BASIS.
230 ** You can optionally give the branch a default color. The
231 ** --private option makes the branch private.
232 **
233 ** %fossil branch list ?-all | --closed?
234 ** %fossil branch ls ?-all | --closed?
235 **
236 ** List all branches. Use --all or --closed to list all branches
237 ** or closed branches. The default is to show only open branches.
238 **
239 ** Options:
240 ** -R|--repository FILE Run commands on repository FILE
241 */
242 void branch_cmd(void){
243 int n;
244 const char *zCmd = "list";
245 db_find_and_open_repository(0, 0);
246
M src/checkin.c
+49 -41
--- src/checkin.c
+++ src/checkin.c
@@ -126,27 +126,25 @@
126126
 }
127127
128128
 /*
129129
 ** COMMAND: changes
130130
 **
131
-** Usage: %fossil changes
131
+** Usage: %fossil changes ?OPTIONS?
132132
 **
133133
 ** Report on the edit status of all files in the current checkout.
134
-** See also the "status" and "extra" commands.
135134
 **
136135
 ** Pathnames are displayed according to the "relative-paths" setting,
137136
 ** unless overridden by the --abs-paths or --rel-paths options.
138137
 **
139138
 ** Options:
140
-**
139
+** --abs-paths Display absolute pathnames.
140
+** --rel-paths Display pathnames relative to the current working
141
+** directory.
141142
 ** --sha1sum Verify file status using SHA1 hashing rather
142143
 ** than relying on file mtimes.
143
-**
144
-** --abs-paths Display absolute pathnames.
145
-**
146
-** --rel-paths Display pathnames relative to the current working
147
-** directory.
144
+**
145
+** See also: extra, ls, status
148146
 */
149147
 void changes_cmd(void){
150148
 Blob report;
151149
 int vid;
152150
 int useSha1sum = find_option("sha1sum", 0, 0)!=0;
@@ -161,26 +159,26 @@
161159
 }
162160
163161
 /*
164162
 ** COMMAND: status
165163
 **
166
-** Usage: %fossil status
164
+** Usage: %fossil status ?OPTIONS?
167165
 **
168166
 ** Report on the status of the current checkout.
169167
 **
170168
 ** Pathnames are displayed according to the "relative-paths" setting,
171169
 ** unless overridden by the --abs-paths or --rel-paths options.
172170
 **
173171
 ** Options:
174172
 **
173
+** --abs-paths Display absolute pathnames.
174
+** --rel-paths Display pathnames relative to the current working
175
+** directory.
175176
 ** --sha1sum Verify file status using SHA1 hashing rather
176177
 ** than relying on file mtimes.
177178
 **
178
-** --abs-paths Display absolute pathnames.
179
-**
180
-** --rel-paths Display pathnames relative to the current working
181
-** directory.
179
+** See also: changes, extra, ls
182180
 */
183181
 void status_cmd(void){
184182
 int vid;
185183
 db_must_be_within_tree();
186184
 /* 012345678901234 */
@@ -195,14 +193,19 @@
195193
 }
196194
197195
 /*
198196
 ** COMMAND: ls
199197
 **
200
-** Usage: %fossil ls [-l]
198
+** Usage: %fossil ls ?OPTIONS?
201199
 **
202200
 ** Show the names of all files in the current checkout. The -l provides
203201
 ** extra information about each file.
202
+**
203
+** Options:
204
+** -l Provide extra information about each file.
205
+**
206
+** See also: changes, extra, status
204207
 */
205208
 void ls_cmd(void){
206209
 int vid;
207210
 Stmt q;
208211
 int isBrief;
@@ -247,11 +250,11 @@
247250
 db_finalize(&q);
248251
 }
249252
250253
 /*
251254
 ** COMMAND: extras
252
-** Usage: %fossil extras ?--dotfiles? ?--ignore GLOBPATTERN?
255
+** Usage: %fossil extras ?OPTIONS?
253256
 **
254257
 ** Print a list of all files in the source tree that are not part of
255258
 ** the current checkout. See also the "clean" command.
256259
 **
257260
 ** Files and subdirectories whose names begin with "." are normally
@@ -263,20 +266,17 @@
263266
 **
264267
 ** Pathnames are displayed according to the "relative-paths" setting,
265268
 ** unless overridden by the --abs-paths or --rel-paths options.
266269
 **
267270
 ** Options:
268
-**
269
-** --dotfiles Include files with names beginning with "."
270
-**
271
-** --ignore GLOBPATTERN
272
-** Override the "ignore-glob" setting.
273
-**
274
-** --abs-paths Display absolute pathnames.
275
-**
276
-** --rel-paths Display pathnames relative to the current working
277
-** directory.
271
+** --abs-paths Display absolute pathnames.
272
+** --dotfiles include files beginning with a dot (".")
273
+** --ignore <CSG> ignore files matching patterns from the
274
+** --rel-paths Display pathnames relative to the current working
275
+** directory.
276
+**
277
+** See also: changes, clean, status
278278
 */
279279
 void extra_cmd(void){
280280
 Blob path;
281281
 Blob repo;
282282
 Stmt q;
@@ -328,15 +328,15 @@
328328
 db_finalize(&q);
329329
 }
330330
331331
 /*
332332
 ** COMMAND: clean
333
-** Usage: %fossil clean ?--force? ?--dotfiles? ?--ignore GLOBPATTERN?
333
+** Usage: %fossil clean ?OPTIONS?
334334
 **
335335
 ** Delete all "extra" files in the source tree. "Extra" files are
336
-** files that are not officially part of the checkout. See also
337
-** the "extra" command. This operation cannot be undone.
336
+** files that are not officially part of the checkout. This operation
337
+** cannot be undone.
338338
 **
339339
 ** You will be prompted before removing each file. If you are
340340
 ** sure you wish to remove all "extra" files you can specify the
341341
 ** optional --force flag and no prompts will be issued.
342342
 **
@@ -345,10 +345,18 @@
345345
 ** is used.
346346
 **
347347
 ** The GLOBPATTERN is a comma-separated list of GLOB expressions for
348348
 ** files that are ignored. The GLOBPATTERN specified by the "ignore-glob"
349349
 ** is used if the --ignore option is omitted.
350
+**
351
+** Options:
352
+** --dotfiles include files beginning with a dot (".")
353
+** --force Remove files without prompting
354
+** --ignore <CSG> ignore files matching patterns from the
355
+** comma separated list of glob patterns.
356
+**
357
+** See also: addremove, extra, status
350358
 */
351359
 void clean_cmd(void){
352360
 int allFlag;
353361
 int dotfilesFlag;
354362
 const char *zIgnoreFlag;
@@ -840,30 +848,30 @@
840848
 ** to be placed in the named branch. The --bgcolor option can be followed
841849
 ** by a color name (ex: '#ffc0c0') to specify the background color of
842850
 ** entries in the new branch when shown in the web timeline interface.
843851
 **
844852
 ** A check-in is not permitted to fork unless the --force or -f
845
-** option appears. A check-in is not allowed against a closed check-in.
853
+** option appears. A check-in is not allowed against a closed leaf.
846854
 **
847855
 ** The --private option creates a private check-in that is never synced.
848856
 ** Children of private check-ins are automatically private.
849857
 **
850858
 ** the --tag option applies the symbolic tag name to the check-in.
851859
 **
852860
 ** Options:
853
-**
854
-** --comment|-m COMMENT-TEXT
855
-** --message-file|-M COMMENT-FILE
856
-** --branch NEW-BRANCH-NAME
857
-** --bgcolor COLOR
858
-** --nosign
859
-** --force|-f
860
-** --private
861
-** --baseline
862
-** --delta
863
-** --tag TAG-NAME
864
-**
861
+** --baseline use a baseline manifest in the commit process
862
+** --bgcolor COLOR apply given COLOR to the branch
863
+** --branch NEW-BRANCH-NAME check in to this new branch
864
+** --comment|-m COMMENT-TEXT use COMMENT-TEXT as commit comment
865
+** --delta use a delta manifest in the commit process
866
+** --force|-f allow forking with this commit
867
+** --message-file|-M FILE read the commit comment from given file
868
+** --nosign do not attempt to sign this commit with gpg
869
+** --private do not sync changes and their descendants
870
+** --tag TAG-NAME assign given tag TAG-NAME to the checkin
871
+**
872
+** See also: branch, changes, checkout, extra, sync
865873
 */
866874
 void commit_cmd(void){
867875
 int hasChanges; /* True if unsaved changes exist */
868876
 int vid; /* blob-id of parent version */
869877
 int nrid; /* blob-id of a modified file */
870878
--- src/checkin.c
+++ src/checkin.c
@@ -126,27 +126,25 @@
126 }
127
128 /*
129 ** COMMAND: changes
130 **
131 ** Usage: %fossil changes
132 **
133 ** Report on the edit status of all files in the current checkout.
134 ** See also the "status" and "extra" commands.
135 **
136 ** Pathnames are displayed according to the "relative-paths" setting,
137 ** unless overridden by the --abs-paths or --rel-paths options.
138 **
139 ** Options:
140 **
 
 
141 ** --sha1sum Verify file status using SHA1 hashing rather
142 ** than relying on file mtimes.
143 **
144 ** --abs-paths Display absolute pathnames.
145 **
146 ** --rel-paths Display pathnames relative to the current working
147 ** directory.
148 */
149 void changes_cmd(void){
150 Blob report;
151 int vid;
152 int useSha1sum = find_option("sha1sum", 0, 0)!=0;
@@ -161,26 +159,26 @@
161 }
162
163 /*
164 ** COMMAND: status
165 **
166 ** Usage: %fossil status
167 **
168 ** Report on the status of the current checkout.
169 **
170 ** Pathnames are displayed according to the "relative-paths" setting,
171 ** unless overridden by the --abs-paths or --rel-paths options.
172 **
173 ** Options:
174 **
 
 
 
175 ** --sha1sum Verify file status using SHA1 hashing rather
176 ** than relying on file mtimes.
177 **
178 ** --abs-paths Display absolute pathnames.
179 **
180 ** --rel-paths Display pathnames relative to the current working
181 ** directory.
182 */
183 void status_cmd(void){
184 int vid;
185 db_must_be_within_tree();
186 /* 012345678901234 */
@@ -195,14 +193,19 @@
195 }
196
197 /*
198 ** COMMAND: ls
199 **
200 ** Usage: %fossil ls [-l]
201 **
202 ** Show the names of all files in the current checkout. The -l provides
203 ** extra information about each file.
 
 
 
 
 
204 */
205 void ls_cmd(void){
206 int vid;
207 Stmt q;
208 int isBrief;
@@ -247,11 +250,11 @@
247 db_finalize(&q);
248 }
249
250 /*
251 ** COMMAND: extras
252 ** Usage: %fossil extras ?--dotfiles? ?--ignore GLOBPATTERN?
253 **
254 ** Print a list of all files in the source tree that are not part of
255 ** the current checkout. See also the "clean" command.
256 **
257 ** Files and subdirectories whose names begin with "." are normally
@@ -263,20 +266,17 @@
263 **
264 ** Pathnames are displayed according to the "relative-paths" setting,
265 ** unless overridden by the --abs-paths or --rel-paths options.
266 **
267 ** Options:
268 **
269 ** --dotfiles Include files with names beginning with "."
270 **
271 ** --ignore GLOBPATTERN
272 ** Override the "ignore-glob" setting.
273 **
274 ** --abs-paths Display absolute pathnames.
275 **
276 ** --rel-paths Display pathnames relative to the current working
277 ** directory.
278 */
279 void extra_cmd(void){
280 Blob path;
281 Blob repo;
282 Stmt q;
@@ -328,15 +328,15 @@
328 db_finalize(&q);
329 }
330
331 /*
332 ** COMMAND: clean
333 ** Usage: %fossil clean ?--force? ?--dotfiles? ?--ignore GLOBPATTERN?
334 **
335 ** Delete all "extra" files in the source tree. "Extra" files are
336 ** files that are not officially part of the checkout. See also
337 ** the "extra" command. This operation cannot be undone.
338 **
339 ** You will be prompted before removing each file. If you are
340 ** sure you wish to remove all "extra" files you can specify the
341 ** optional --force flag and no prompts will be issued.
342 **
@@ -345,10 +345,18 @@
345 ** is used.
346 **
347 ** The GLOBPATTERN is a comma-separated list of GLOB expressions for
348 ** files that are ignored. The GLOBPATTERN specified by the "ignore-glob"
349 ** is used if the --ignore option is omitted.
 
 
 
 
 
 
 
 
350 */
351 void clean_cmd(void){
352 int allFlag;
353 int dotfilesFlag;
354 const char *zIgnoreFlag;
@@ -840,30 +848,30 @@
840 ** to be placed in the named branch. The --bgcolor option can be followed
841 ** by a color name (ex: '#ffc0c0') to specify the background color of
842 ** entries in the new branch when shown in the web timeline interface.
843 **
844 ** A check-in is not permitted to fork unless the --force or -f
845 ** option appears. A check-in is not allowed against a closed check-in.
846 **
847 ** The --private option creates a private check-in that is never synced.
848 ** Children of private check-ins are automatically private.
849 **
850 ** the --tag option applies the symbolic tag name to the check-in.
851 **
852 ** Options:
853 **
854 ** --comment|-m COMMENT-TEXT
855 ** --message-file|-M COMMENT-FILE
856 ** --branch NEW-BRANCH-NAME
857 ** --bgcolor COLOR
858 ** --nosign
859 ** --force|-f
860 ** --private
861 ** --baseline
862 ** --delta
863 ** --tag TAG-NAME
864 **
865 */
866 void commit_cmd(void){
867 int hasChanges; /* True if unsaved changes exist */
868 int vid; /* blob-id of parent version */
869 int nrid; /* blob-id of a modified file */
870
--- src/checkin.c
+++ src/checkin.c
@@ -126,27 +126,25 @@
126 }
127
128 /*
129 ** COMMAND: changes
130 **
131 ** Usage: %fossil changes ?OPTIONS?
132 **
133 ** Report on the edit status of all files in the current checkout.
 
134 **
135 ** Pathnames are displayed according to the "relative-paths" setting,
136 ** unless overridden by the --abs-paths or --rel-paths options.
137 **
138 ** Options:
139 ** --abs-paths Display absolute pathnames.
140 ** --rel-paths Display pathnames relative to the current working
141 ** directory.
142 ** --sha1sum Verify file status using SHA1 hashing rather
143 ** than relying on file mtimes.
144 **
145 ** See also: extra, ls, status
 
 
 
146 */
147 void changes_cmd(void){
148 Blob report;
149 int vid;
150 int useSha1sum = find_option("sha1sum", 0, 0)!=0;
@@ -161,26 +159,26 @@
159 }
160
161 /*
162 ** COMMAND: status
163 **
164 ** Usage: %fossil status ?OPTIONS?
165 **
166 ** Report on the status of the current checkout.
167 **
168 ** Pathnames are displayed according to the "relative-paths" setting,
169 ** unless overridden by the --abs-paths or --rel-paths options.
170 **
171 ** Options:
172 **
173 ** --abs-paths Display absolute pathnames.
174 ** --rel-paths Display pathnames relative to the current working
175 ** directory.
176 ** --sha1sum Verify file status using SHA1 hashing rather
177 ** than relying on file mtimes.
178 **
179 ** See also: changes, extra, ls
 
 
 
180 */
181 void status_cmd(void){
182 int vid;
183 db_must_be_within_tree();
184 /* 012345678901234 */
@@ -195,14 +193,19 @@
193 }
194
195 /*
196 ** COMMAND: ls
197 **
198 ** Usage: %fossil ls ?OPTIONS?
199 **
200 ** Show the names of all files in the current checkout. The -l provides
201 ** extra information about each file.
202 **
203 ** Options:
204 ** -l Provide extra information about each file.
205 **
206 ** See also: changes, extra, status
207 */
208 void ls_cmd(void){
209 int vid;
210 Stmt q;
211 int isBrief;
@@ -247,11 +250,11 @@
250 db_finalize(&q);
251 }
252
253 /*
254 ** COMMAND: extras
255 ** Usage: %fossil extras ?OPTIONS?
256 **
257 ** Print a list of all files in the source tree that are not part of
258 ** the current checkout. See also the "clean" command.
259 **
260 ** Files and subdirectories whose names begin with "." are normally
@@ -263,20 +266,17 @@
266 **
267 ** Pathnames are displayed according to the "relative-paths" setting,
268 ** unless overridden by the --abs-paths or --rel-paths options.
269 **
270 ** Options:
271 ** --abs-paths Display absolute pathnames.
272 ** --dotfiles include files beginning with a dot (".")
273 ** --ignore <CSG> ignore files matching patterns from the
274 ** --rel-paths Display pathnames relative to the current working
275 ** directory.
276 **
277 ** See also: changes, clean, status
 
 
 
278 */
279 void extra_cmd(void){
280 Blob path;
281 Blob repo;
282 Stmt q;
@@ -328,15 +328,15 @@
328 db_finalize(&q);
329 }
330
331 /*
332 ** COMMAND: clean
333 ** Usage: %fossil clean ?OPTIONS?
334 **
335 ** Delete all "extra" files in the source tree. "Extra" files are
336 ** files that are not officially part of the checkout. This operation
337 ** cannot be undone.
338 **
339 ** You will be prompted before removing each file. If you are
340 ** sure you wish to remove all "extra" files you can specify the
341 ** optional --force flag and no prompts will be issued.
342 **
@@ -345,10 +345,18 @@
345 ** is used.
346 **
347 ** The GLOBPATTERN is a comma-separated list of GLOB expressions for
348 ** files that are ignored. The GLOBPATTERN specified by the "ignore-glob"
349 ** is used if the --ignore option is omitted.
350 **
351 ** Options:
352 ** --dotfiles include files beginning with a dot (".")
353 ** --force Remove files without prompting
354 ** --ignore <CSG> ignore files matching patterns from the
355 ** comma separated list of glob patterns.
356 **
357 ** See also: addremove, extra, status
358 */
359 void clean_cmd(void){
360 int allFlag;
361 int dotfilesFlag;
362 const char *zIgnoreFlag;
@@ -840,30 +848,30 @@
848 ** to be placed in the named branch. The --bgcolor option can be followed
849 ** by a color name (ex: '#ffc0c0') to specify the background color of
850 ** entries in the new branch when shown in the web timeline interface.
851 **
852 ** A check-in is not permitted to fork unless the --force or -f
853 ** option appears. A check-in is not allowed against a closed leaf.
854 **
855 ** The --private option creates a private check-in that is never synced.
856 ** Children of private check-ins are automatically private.
857 **
858 ** the --tag option applies the symbolic tag name to the check-in.
859 **
860 ** Options:
861 ** --baseline use a baseline manifest in the commit process
862 ** --bgcolor COLOR apply given COLOR to the branch
863 ** --branch NEW-BRANCH-NAME check in to this new branch
864 ** --comment|-m COMMENT-TEXT use COMMENT-TEXT as commit comment
865 ** --delta use a delta manifest in the commit process
866 ** --force|-f allow forking with this commit
867 ** --message-file|-M FILE read the commit comment from given file
868 ** --nosign do not attempt to sign this commit with gpg
869 ** --private do not sync changes and their descendants
870 ** --tag TAG-NAME assign given tag TAG-NAME to the checkin
871 **
872 ** See also: branch, changes, checkout, extra, sync
873 */
874 void commit_cmd(void){
875 int hasChanges; /* True if unsaved changes exist */
876 int vid; /* blob-id of parent version */
877 int nrid; /* blob-id of a modified file */
878
M src/checkout.c
+13 -3
--- src/checkout.c
+++ src/checkout.c
@@ -164,22 +164,27 @@
164164
165165
 /*
166166
 ** COMMAND: checkout
167167
 ** COMMAND: co
168168
 **
169
-** Usage: %fossil checkout VERSION ?-f|--force? ?--keep?
169
+** Usage: %fossil checkout ?VERSION | --latest? ?OPTIONS?
170
+** or: %fossil co ?VERSION | --latest? ?OPTIONS?
170171
 **
171172
 ** Check out a version specified on the command-line. This command
172173
 ** will abort if there are edited files in the current checkout unless
173174
 ** the --force option appears on the command-line. The --keep option
174175
 ** leaves files on disk unchanged, except the manifest and manifest.uuid
175176
 ** files.
176177
 **
177178
 ** The --latest flag can be used in place of VERSION to checkout the
178179
 ** latest version in the repository.
180
+**
181
+** Options:
182
+** --force Ignore edited files in the current checkout
183
+** --keep Only update the manifest and manifest.uuid files
179184
 **
180
-** See also the "update" command.
185
+** See also: update
181186
 */
182187
 void checkout_cmd(void){
183188
 int forceFlag; /* Force checkout even if edits exist */
184189
 int keepFlag; /* Do not change any files on disk */
185190
 int latestFlag; /* Checkout the latest version */
@@ -269,15 +274,20 @@
269274
 }
270275
271276
 /*
272277
 ** COMMAND: close
273278
 **
274
-** Usage: %fossil close ?-f|--force?
279
+** Usage: %fossil close ?OPTIONS?
275280
 **
276281
 ** The opposite of "open". Close the current database connection.
277282
 ** Require a -f or --force flag if there are unsaved changed in the
278283
 ** current check-out.
284
+**
285
+** Options:
286
+** --force|-f necessary to close a check out with uncommitted changes
287
+**
288
+** See also: open
279289
 */
280290
 void close_cmd(void){
281291
 int forceFlag = find_option("force","f",0)!=0;
282292
 db_must_be_within_tree();
283293
 if( !forceFlag && unsaved_changes()==1 ){
284294
--- src/checkout.c
+++ src/checkout.c
@@ -164,22 +164,27 @@
164
165 /*
166 ** COMMAND: checkout
167 ** COMMAND: co
168 **
169 ** Usage: %fossil checkout VERSION ?-f|--force? ?--keep?
 
170 **
171 ** Check out a version specified on the command-line. This command
172 ** will abort if there are edited files in the current checkout unless
173 ** the --force option appears on the command-line. The --keep option
174 ** leaves files on disk unchanged, except the manifest and manifest.uuid
175 ** files.
176 **
177 ** The --latest flag can be used in place of VERSION to checkout the
178 ** latest version in the repository.
 
 
 
 
179 **
180 ** See also the "update" command.
181 */
182 void checkout_cmd(void){
183 int forceFlag; /* Force checkout even if edits exist */
184 int keepFlag; /* Do not change any files on disk */
185 int latestFlag; /* Checkout the latest version */
@@ -269,15 +274,20 @@
269 }
270
271 /*
272 ** COMMAND: close
273 **
274 ** Usage: %fossil close ?-f|--force?
275 **
276 ** The opposite of "open". Close the current database connection.
277 ** Require a -f or --force flag if there are unsaved changed in the
278 ** current check-out.
 
 
 
 
 
279 */
280 void close_cmd(void){
281 int forceFlag = find_option("force","f",0)!=0;
282 db_must_be_within_tree();
283 if( !forceFlag && unsaved_changes()==1 ){
284
--- src/checkout.c
+++ src/checkout.c
@@ -164,22 +164,27 @@
164
165 /*
166 ** COMMAND: checkout
167 ** COMMAND: co
168 **
169 ** Usage: %fossil checkout ?VERSION | --latest? ?OPTIONS?
170 ** or: %fossil co ?VERSION | --latest? ?OPTIONS?
171 **
172 ** Check out a version specified on the command-line. This command
173 ** will abort if there are edited files in the current checkout unless
174 ** the --force option appears on the command-line. The --keep option
175 ** leaves files on disk unchanged, except the manifest and manifest.uuid
176 ** files.
177 **
178 ** The --latest flag can be used in place of VERSION to checkout the
179 ** latest version in the repository.
180 **
181 ** Options:
182 ** --force Ignore edited files in the current checkout
183 ** --keep Only update the manifest and manifest.uuid files
184 **
185 ** See also: update
186 */
187 void checkout_cmd(void){
188 int forceFlag; /* Force checkout even if edits exist */
189 int keepFlag; /* Do not change any files on disk */
190 int latestFlag; /* Checkout the latest version */
@@ -269,15 +274,20 @@
274 }
275
276 /*
277 ** COMMAND: close
278 **
279 ** Usage: %fossil close ?OPTIONS?
280 **
281 ** The opposite of "open". Close the current database connection.
282 ** Require a -f or --force flag if there are unsaved changed in the
283 ** current check-out.
284 **
285 ** Options:
286 ** --force|-f necessary to close a check out with uncommitted changes
287 **
288 ** See also: open
289 */
290 void close_cmd(void){
291 int forceFlag = find_option("force","f",0)!=0;
292 db_must_be_within_tree();
293 if( !forceFlag && unsaved_changes()==1 ){
294
M src/clone.c
+4 -4
--- src/clone.c
+++ src/clone.c
@@ -34,15 +34,15 @@
3434
 ** By default, your current login name is used to create the default
3535
 ** admin user. This can be overridden using the -A|--admin-user
3636
 ** parameter.
3737
 **
3838
 ** Options:
39
-**
40
-** --admin-user|-A USERNAME Make USERNAME the administrator
41
-** --private Also clone private branches
42
-** --ssl-identity=filename Use the SSL identity if requested by the server
39
+** --admin-user|-A USERNAME Make USERNAME the administrator
40
+** --private Also clone private branches
41
+** --ssl-identity=filename Use the SSL identity if requested by the server
4342
 **
43
+** See also: init
4444
 */
4545
 void clone_cmd(void){
4646
 char *zPassword;
4747
 const char *zDefaultUser; /* Optional name of the default user */
4848
 const char *zPw; /* The user clone password */
4949
--- src/clone.c
+++ src/clone.c
@@ -34,15 +34,15 @@
34 ** By default, your current login name is used to create the default
35 ** admin user. This can be overridden using the -A|--admin-user
36 ** parameter.
37 **
38 ** Options:
39 **
40 ** --admin-user|-A USERNAME Make USERNAME the administrator
41 ** --private Also clone private branches
42 ** --ssl-identity=filename Use the SSL identity if requested by the server
43 **
 
44 */
45 void clone_cmd(void){
46 char *zPassword;
47 const char *zDefaultUser; /* Optional name of the default user */
48 const char *zPw; /* The user clone password */
49
--- src/clone.c
+++ src/clone.c
@@ -34,15 +34,15 @@
34 ** By default, your current login name is used to create the default
35 ** admin user. This can be overridden using the -A|--admin-user
36 ** parameter.
37 **
38 ** Options:
39 ** --admin-user|-A USERNAME Make USERNAME the administrator
40 ** --private Also clone private branches
41 ** --ssl-identity=filename Use the SSL identity if requested by the server
 
42 **
43 ** See also: init
44 */
45 void clone_cmd(void){
46 char *zPassword;
47 const char *zDefaultUser; /* Optional name of the default user */
48 const char *zPw; /* The user clone password */
49
M src/clone.c
+4 -4
--- src/clone.c
+++ src/clone.c
@@ -34,15 +34,15 @@
3434
 ** By default, your current login name is used to create the default
3535
 ** admin user. This can be overridden using the -A|--admin-user
3636
 ** parameter.
3737
 **
3838
 ** Options:
39
-**
40
-** --admin-user|-A USERNAME Make USERNAME the administrator
41
-** --private Also clone private branches
42
-** --ssl-identity=filename Use the SSL identity if requested by the server
39
+** --admin-user|-A USERNAME Make USERNAME the administrator
40
+** --private Also clone private branches
41
+** --ssl-identity=filename Use the SSL identity if requested by the server
4342
 **
43
+** See also: init
4444
 */
4545
 void clone_cmd(void){
4646
 char *zPassword;
4747
 const char *zDefaultUser; /* Optional name of the default user */
4848
 const char *zPw; /* The user clone password */
4949
--- src/clone.c
+++ src/clone.c
@@ -34,15 +34,15 @@
34 ** By default, your current login name is used to create the default
35 ** admin user. This can be overridden using the -A|--admin-user
36 ** parameter.
37 **
38 ** Options:
39 **
40 ** --admin-user|-A USERNAME Make USERNAME the administrator
41 ** --private Also clone private branches
42 ** --ssl-identity=filename Use the SSL identity if requested by the server
43 **
 
44 */
45 void clone_cmd(void){
46 char *zPassword;
47 const char *zDefaultUser; /* Optional name of the default user */
48 const char *zPw; /* The user clone password */
49
--- src/clone.c
+++ src/clone.c
@@ -34,15 +34,15 @@
34 ** By default, your current login name is used to create the default
35 ** admin user. This can be overridden using the -A|--admin-user
36 ** parameter.
37 **
38 ** Options:
39 ** --admin-user|-A USERNAME Make USERNAME the administrator
40 ** --private Also clone private branches
41 ** --ssl-identity=filename Use the SSL identity if requested by the server
 
42 **
43 ** See also: init
44 */
45 void clone_cmd(void){
46 char *zPassword;
47 const char *zDefaultUser; /* Optional name of the default user */
48 const char *zPw; /* The user clone password */
49
M src/configure.c
+6 -1
--- src/configure.c
+++ src/configure.c
@@ -726,11 +726,11 @@
726726
727727
728728
 /*
729729
 ** COMMAND: configuration
730730
 **
731
-** Usage: %fossil configuration METHOD ... ?-R|--repository REPOSITORY?
731
+** Usage: %fossil configuration METHOD ... ?OPTIONS?
732732
 **
733733
 ** Where METHOD is one of: export import merge pull push reset. All methods
734734
 ** accept the -R or --repository option to specific a repository.
735735
 **
736736
 ** %fossil configuration export AREA FILENAME
@@ -772,10 +772,15 @@
772772
 **
773773
 ** %fossil configuration sync AREA ?URL?
774774
 **
775775
 ** Synchronize configuration changes in the local repository with
776776
 ** the remote repository at URL.
777
+**
778
+** Options:
779
+** -R|--repository FILE Extract info from repository FILE
780
+**
781
+** See also: set
777782
 */
778783
 void configuration_cmd(void){
779784
 int n;
780785
 const char *zMethod;
781786
 if( g.argc<3 ){
782787
--- src/configure.c
+++ src/configure.c
@@ -726,11 +726,11 @@
726
727
728 /*
729 ** COMMAND: configuration
730 **
731 ** Usage: %fossil configuration METHOD ... ?-R|--repository REPOSITORY?
732 **
733 ** Where METHOD is one of: export import merge pull push reset. All methods
734 ** accept the -R or --repository option to specific a repository.
735 **
736 ** %fossil configuration export AREA FILENAME
@@ -772,10 +772,15 @@
772 **
773 ** %fossil configuration sync AREA ?URL?
774 **
775 ** Synchronize configuration changes in the local repository with
776 ** the remote repository at URL.
 
 
 
 
 
777 */
778 void configuration_cmd(void){
779 int n;
780 const char *zMethod;
781 if( g.argc<3 ){
782
--- src/configure.c
+++ src/configure.c
@@ -726,11 +726,11 @@
726
727
728 /*
729 ** COMMAND: configuration
730 **
731 ** Usage: %fossil configuration METHOD ... ?OPTIONS?
732 **
733 ** Where METHOD is one of: export import merge pull push reset. All methods
734 ** accept the -R or --repository option to specific a repository.
735 **
736 ** %fossil configuration export AREA FILENAME
@@ -772,10 +772,15 @@
772 **
773 ** %fossil configuration sync AREA ?URL?
774 **
775 ** Synchronize configuration changes in the local repository with
776 ** the remote repository at URL.
777 **
778 ** Options:
779 ** -R|--repository FILE Extract info from repository FILE
780 **
781 ** See also: set
782 */
783 void configuration_cmd(void){
784 int n;
785 const char *zMethod;
786 if( g.argc<3 ){
787
M src/content.c
-1
--- src/content.c
+++ src/content.c
@@ -312,11 +312,10 @@
312312
 ** Extract an artifact by its SHA1 hash and write the results on
313313
 ** standard output, or if the optional 4th argument is given, in
314314
 ** the named output file.
315315
 **
316316
 ** Options:
317
-**
318317
 ** -R|--repository FILE Extract artifacts from repository FILE
319318
 */
320319
 void artifact_cmd(void){
321320
 int rid;
322321
 Blob content;
323322
--- src/content.c
+++ src/content.c
@@ -312,11 +312,10 @@
312 ** Extract an artifact by its SHA1 hash and write the results on
313 ** standard output, or if the optional 4th argument is given, in
314 ** the named output file.
315 **
316 ** Options:
317 **
318 ** -R|--repository FILE Extract artifacts from repository FILE
319 */
320 void artifact_cmd(void){
321 int rid;
322 Blob content;
323
--- src/content.c
+++ src/content.c
@@ -312,11 +312,10 @@
312 ** Extract an artifact by its SHA1 hash and write the results on
313 ** standard output, or if the optional 4th argument is given, in
314 ** the named output file.
315 **
316 ** Options:
 
317 ** -R|--repository FILE Extract artifacts from repository FILE
318 */
319 void artifact_cmd(void){
320 int rid;
321 Blob content;
322
M src/db.c
+9 -5
--- src/db.c
+++ src/db.c
@@ -1179,14 +1179,14 @@
11791179
 ** By default, your current login name is used to create the default
11801180
 ** admin user. This can be overridden using the -A|--admin-user
11811181
 ** parameter.
11821182
 **
11831183
 ** Options:
1184
-**
1185
-** --admin-user|-A USERNAME
1186
-** --date-override DATETIME
1184
+** --admin-user|-A USERNAME select given USERNAME as admin user
1185
+** --date-override DATETIME use DATETIME as time of the initial checkin
11871186
 **
1187
+** See also: clone
11881188
 */
11891189
 void create_repository_cmd(void){
11901190
 char *zPassword;
11911191
 const char *zDate; /* Date of the initial check-in */
11921192
 const char *zDefaultUser; /* Optional name of the default user */
@@ -1642,19 +1642,23 @@
16421642
 }
16431643
16441644
 /*
16451645
 ** COMMAND: open
16461646
 **
1647
-** Usage: %fossil open FILENAME ?VERSION? ?--keep? ?--nested?
1647
+** Usage: %fossil open FILENAME ?VERSION? ?OPTIONS?
16481648
 **
16491649
 ** Open a connection to the local repository in FILENAME. A checkout
16501650
 ** for the repository is created with its root at the working directory.
16511651
 ** If VERSION is specified then that version is checked out. Otherwise
16521652
 ** the latest version is checked out. No files other than "manifest"
16531653
 ** and "manifest.uuid" are modified if the --keep option is present.
16541654
 **
1655
-** See also the "close" command.
1655
+** Options:
1656
+** --keep Only modify the manifest and manifest.uuid files
1657
+** --nested Allow opening a repository inside an opened checkout
1658
+**
1659
+** See also: close
16561660
 */
16571661
 void cmd_open(void){
16581662
 Blob path;
16591663
 int vid;
16601664
 int keepFlag;
16611665
--- src/db.c
+++ src/db.c
@@ -1179,14 +1179,14 @@
1179 ** By default, your current login name is used to create the default
1180 ** admin user. This can be overridden using the -A|--admin-user
1181 ** parameter.
1182 **
1183 ** Options:
1184 **
1185 ** --admin-user|-A USERNAME
1186 ** --date-override DATETIME
1187 **
 
1188 */
1189 void create_repository_cmd(void){
1190 char *zPassword;
1191 const char *zDate; /* Date of the initial check-in */
1192 const char *zDefaultUser; /* Optional name of the default user */
@@ -1642,19 +1642,23 @@
1642 }
1643
1644 /*
1645 ** COMMAND: open
1646 **
1647 ** Usage: %fossil open FILENAME ?VERSION? ?--keep? ?--nested?
1648 **
1649 ** Open a connection to the local repository in FILENAME. A checkout
1650 ** for the repository is created with its root at the working directory.
1651 ** If VERSION is specified then that version is checked out. Otherwise
1652 ** the latest version is checked out. No files other than "manifest"
1653 ** and "manifest.uuid" are modified if the --keep option is present.
1654 **
1655 ** See also the "close" command.
 
 
 
 
1656 */
1657 void cmd_open(void){
1658 Blob path;
1659 int vid;
1660 int keepFlag;
1661
--- src/db.c
+++ src/db.c
@@ -1179,14 +1179,14 @@
1179 ** By default, your current login name is used to create the default
1180 ** admin user. This can be overridden using the -A|--admin-user
1181 ** parameter.
1182 **
1183 ** Options:
1184 ** --admin-user|-A USERNAME select given USERNAME as admin user
1185 ** --date-override DATETIME use DATETIME as time of the initial checkin
 
1186 **
1187 ** See also: clone
1188 */
1189 void create_repository_cmd(void){
1190 char *zPassword;
1191 const char *zDate; /* Date of the initial check-in */
1192 const char *zDefaultUser; /* Optional name of the default user */
@@ -1642,19 +1642,23 @@
1642 }
1643
1644 /*
1645 ** COMMAND: open
1646 **
1647 ** Usage: %fossil open FILENAME ?VERSION? ?OPTIONS?
1648 **
1649 ** Open a connection to the local repository in FILENAME. A checkout
1650 ** for the repository is created with its root at the working directory.
1651 ** If VERSION is specified then that version is checked out. Otherwise
1652 ** the latest version is checked out. No files other than "manifest"
1653 ** and "manifest.uuid" are modified if the --keep option is present.
1654 **
1655 ** Options:
1656 ** --keep Only modify the manifest and manifest.uuid files
1657 ** --nested Allow opening a repository inside an opened checkout
1658 **
1659 ** See also: close
1660 */
1661 void cmd_open(void){
1662 Blob path;
1663 int vid;
1664 int keepFlag;
1665
M src/descendants.c
+10 -2
--- src/descendants.c
+++ src/descendants.c
@@ -270,12 +270,13 @@
270270
 **
271271
 ** Find all leaf descendants of the baseline specified or if the argument
272272
 ** is omitted, of the baseline currently checked out.
273273
 **
274274
 ** Options:
275
-**
276275
 ** -R|--repository FILE Extract info from repository FILE
276
+**
277
+** See also: finfo, info, leaves
277278
 */
278279
 void descendants_cmd(void){
279280
 Stmt q;
280281
 int base;
281282
@@ -298,18 +299,25 @@
298299
 }
299300
300301
 /*
301302
 ** COMMAND: leaves
302303
 **
303
-** Usage: %fossil leaves ?--all? ?--closed?
304
+** Usage: %fossil leaves ?OPTIONS?
304305
 **
305306
 ** Find leaves of all branches. By default show only open leaves.
306307
 ** The --all flag causes all leaves (closed and open) to be shown.
307308
 ** The --closed flag shows only closed leaves.
308309
 **
309310
 ** The --recompute flag causes the content of the "leaf" table in the
310311
 ** repository database to be recomputed.
312
+**
313
+** Options:
314
+** --all show ALL leaves
315
+** --closed show only closed leaves
316
+** --recompute recompute the "leaf" table in the repository DB
317
+**
318
+** See also: descendants, finfo, info, branch
311319
 */
312320
 void leaves_cmd(void){
313321
 Stmt q;
314322
 Blob sql;
315323
 int showAll = find_option("all", 0, 0)!=0;
316324
--- src/descendants.c
+++ src/descendants.c
@@ -270,12 +270,13 @@
270 **
271 ** Find all leaf descendants of the baseline specified or if the argument
272 ** is omitted, of the baseline currently checked out.
273 **
274 ** Options:
275 **
276 ** -R|--repository FILE Extract info from repository FILE
 
 
277 */
278 void descendants_cmd(void){
279 Stmt q;
280 int base;
281
@@ -298,18 +299,25 @@
298 }
299
300 /*
301 ** COMMAND: leaves
302 **
303 ** Usage: %fossil leaves ?--all? ?--closed?
304 **
305 ** Find leaves of all branches. By default show only open leaves.
306 ** The --all flag causes all leaves (closed and open) to be shown.
307 ** The --closed flag shows only closed leaves.
308 **
309 ** The --recompute flag causes the content of the "leaf" table in the
310 ** repository database to be recomputed.
 
 
 
 
 
 
 
311 */
312 void leaves_cmd(void){
313 Stmt q;
314 Blob sql;
315 int showAll = find_option("all", 0, 0)!=0;
316
--- src/descendants.c
+++ src/descendants.c
@@ -270,12 +270,13 @@
270 **
271 ** Find all leaf descendants of the baseline specified or if the argument
272 ** is omitted, of the baseline currently checked out.
273 **
274 ** Options:
 
275 ** -R|--repository FILE Extract info from repository FILE
276 **
277 ** See also: finfo, info, leaves
278 */
279 void descendants_cmd(void){
280 Stmt q;
281 int base;
282
@@ -298,18 +299,25 @@
299 }
300
301 /*
302 ** COMMAND: leaves
303 **
304 ** Usage: %fossil leaves ?OPTIONS?
305 **
306 ** Find leaves of all branches. By default show only open leaves.
307 ** The --all flag causes all leaves (closed and open) to be shown.
308 ** The --closed flag shows only closed leaves.
309 **
310 ** The --recompute flag causes the content of the "leaf" table in the
311 ** repository database to be recomputed.
312 **
313 ** Options:
314 ** --all show ALL leaves
315 ** --closed show only closed leaves
316 ** --recompute recompute the "leaf" table in the repository DB
317 **
318 ** See also: descendants, finfo, info, branch
319 */
320 void leaves_cmd(void){
321 Stmt q;
322 Blob sql;
323 int showAll = find_option("all", 0, 0)!=0;
324
M src/diff.c
+1 -1
--- src/diff.c
+++ src/diff.c
@@ -871,11 +871,11 @@
871871
 }
872872
873873
 /*
874874
 ** COMMAND: annotate
875875
 **
876
-** %fossil annotate FILENAME
876
+** %fossil annotate ?OPTIONS? FILENAME
877877
 **
878878
 ** Output the text of a file with markings to show when each line of
879879
 ** the file was last modified.
880880
 **
881881
 ** Options:
882882
--- src/diff.c
+++ src/diff.c
@@ -871,11 +871,11 @@
871 }
872
873 /*
874 ** COMMAND: annotate
875 **
876 ** %fossil annotate FILENAME
877 **
878 ** Output the text of a file with markings to show when each line of
879 ** the file was last modified.
880 **
881 ** Options:
882
--- src/diff.c
+++ src/diff.c
@@ -871,11 +871,11 @@
871 }
872
873 /*
874 ** COMMAND: annotate
875 **
876 ** %fossil annotate ?OPTIONS? FILENAME
877 **
878 ** Output the text of a file with markings to show when each line of
879 ** the file was last modified.
880 **
881 ** Options:
882
M src/diffcmd.c
+7 -1
--- src/diffcmd.c
+++ src/diffcmd.c
@@ -431,11 +431,11 @@
431431
432432
 /*
433433
 ** COMMAND: diff
434434
 ** COMMAND: gdiff
435435
 **
436
-** Usage: %fossil diff|gdiff ?options? ?FILE1? ?FILE2 ...?
436
+** Usage: %fossil diff|gdiff ?OPTIONS? ?FILE1? ?FILE2 ...?
437437
 **
438438
 ** Show the difference between the current version of each of the FILEs
439439
 ** specified (as they exist on disk) and that same file as it was checked
440440
 ** out. Or if the FILE arguments are omitted, show the unsaved changed
441441
 ** currently in the working check-out.
@@ -454,10 +454,16 @@
454454
 ** the "setting" command. If no external diff program is configured, then
455455
 ** the "-i" option is a no-op. The "-i" option converts "gdiff" into "diff".
456456
 **
457457
 ** The "-N" or "--new-file" option causes the complete text of added or
458458
 ** deleted files to be displayed.
459
+**
460
+** Options:
461
+** --from|-r VERSION select VERSION as source for the diff
462
+** --new-file|-N output complete text of added or deleted files
463
+** -i use internal diff logic
464
+** --to VERSION select VERSION as target for the diff
459465
 */
460466
 void diff_cmd(void){
461467
 int isGDiff; /* True for gdiff. False for normal diff */
462468
 int isInternDiff; /* True for internal diff */
463469
 int hasNFlag; /* True if -N or --new-file flag is used */
464470
--- src/diffcmd.c
+++ src/diffcmd.c
@@ -431,11 +431,11 @@
431
432 /*
433 ** COMMAND: diff
434 ** COMMAND: gdiff
435 **
436 ** Usage: %fossil diff|gdiff ?options? ?FILE1? ?FILE2 ...?
437 **
438 ** Show the difference between the current version of each of the FILEs
439 ** specified (as they exist on disk) and that same file as it was checked
440 ** out. Or if the FILE arguments are omitted, show the unsaved changed
441 ** currently in the working check-out.
@@ -454,10 +454,16 @@
454 ** the "setting" command. If no external diff program is configured, then
455 ** the "-i" option is a no-op. The "-i" option converts "gdiff" into "diff".
456 **
457 ** The "-N" or "--new-file" option causes the complete text of added or
458 ** deleted files to be displayed.
 
 
 
 
 
 
459 */
460 void diff_cmd(void){
461 int isGDiff; /* True for gdiff. False for normal diff */
462 int isInternDiff; /* True for internal diff */
463 int hasNFlag; /* True if -N or --new-file flag is used */
464
--- src/diffcmd.c
+++ src/diffcmd.c
@@ -431,11 +431,11 @@
431
432 /*
433 ** COMMAND: diff
434 ** COMMAND: gdiff
435 **
436 ** Usage: %fossil diff|gdiff ?OPTIONS? ?FILE1? ?FILE2 ...?
437 **
438 ** Show the difference between the current version of each of the FILEs
439 ** specified (as they exist on disk) and that same file as it was checked
440 ** out. Or if the FILE arguments are omitted, show the unsaved changed
441 ** currently in the working check-out.
@@ -454,10 +454,16 @@
454 ** the "setting" command. If no external diff program is configured, then
455 ** the "-i" option is a no-op. The "-i" option converts "gdiff" into "diff".
456 **
457 ** The "-N" or "--new-file" option causes the complete text of added or
458 ** deleted files to be displayed.
459 **
460 ** Options:
461 ** --from|-r VERSION select VERSION as source for the diff
462 ** --new-file|-N output complete text of added or deleted files
463 ** -i use internal diff logic
464 ** --to VERSION select VERSION as target for the diff
465 */
466 void diff_cmd(void){
467 int isGDiff; /* True for gdiff. False for normal diff */
468 int isInternDiff; /* True for internal diff */
469 int hasNFlag; /* True if -N or --new-file flag is used */
470
M src/export.c
+8 -1
--- src/export.c
+++ src/export.c
@@ -84,11 +84,11 @@
8484
 #define COMMITMARK(rid) ((rid) * 2 + 1)
8585
8686
 /*
8787
 ** COMMAND: export
8888
 **
89
-** Usage: %fossil export --git ?options? ?REPOSITORY?
89
+** Usage: %fossil export --git ?OPTIONS? ?REPOSITORY?
9090
 **
9191
 ** Write an export of all check-ins to standard output. The export is
9292
 ** written in the git-fast-export file format assuming the --git option is
9393
 ** provided. The git-fast-export format is currently the only VCS
9494
 ** interchange format supported, though other formats may be added in
@@ -103,10 +103,17 @@
103103
 ** If the "--import-marks FILE" option is used, it contains a list of
104104
 ** rids to skip.
105105
 **
106106
 ** If the "--export-marks FILE" option is used, the rid of all commits and
107107
 ** blobs written on exit for use with "--import-marks" on the next run.
108
+**
109
+** Options:
110
+** --export-marks FILE export rids of exported data to FILE
111
+** --import-marks FILE read rids of data to ignore from FILE
112
+** --repository|-R REPOSITORY export the given REPOSITORY
113
+**
114
+** See also: import
108115
 */
109116
 void export_cmd(void){
110117
 Stmt q, q2, q3;
111118
 int i;
112119
 Bag blobs, vers;
113120
--- src/export.c
+++ src/export.c
@@ -84,11 +84,11 @@
84 #define COMMITMARK(rid) ((rid) * 2 + 1)
85
86 /*
87 ** COMMAND: export
88 **
89 ** Usage: %fossil export --git ?options? ?REPOSITORY?
90 **
91 ** Write an export of all check-ins to standard output. The export is
92 ** written in the git-fast-export file format assuming the --git option is
93 ** provided. The git-fast-export format is currently the only VCS
94 ** interchange format supported, though other formats may be added in
@@ -103,10 +103,17 @@
103 ** If the "--import-marks FILE" option is used, it contains a list of
104 ** rids to skip.
105 **
106 ** If the "--export-marks FILE" option is used, the rid of all commits and
107 ** blobs written on exit for use with "--import-marks" on the next run.
 
 
 
 
 
 
 
108 */
109 void export_cmd(void){
110 Stmt q, q2, q3;
111 int i;
112 Bag blobs, vers;
113
--- src/export.c
+++ src/export.c
@@ -84,11 +84,11 @@
84 #define COMMITMARK(rid) ((rid) * 2 + 1)
85
86 /*
87 ** COMMAND: export
88 **
89 ** Usage: %fossil export --git ?OPTIONS? ?REPOSITORY?
90 **
91 ** Write an export of all check-ins to standard output. The export is
92 ** written in the git-fast-export file format assuming the --git option is
93 ** provided. The git-fast-export format is currently the only VCS
94 ** interchange format supported, though other formats may be added in
@@ -103,10 +103,17 @@
103 ** If the "--import-marks FILE" option is used, it contains a list of
104 ** rids to skip.
105 **
106 ** If the "--export-marks FILE" option is used, the rid of all commits and
107 ** blobs written on exit for use with "--import-marks" on the next run.
108 **
109 ** Options:
110 ** --export-marks FILE export rids of exported data to FILE
111 ** --import-marks FILE read rids of data to ignore from FILE
112 ** --repository|-R REPOSITORY export the given REPOSITORY
113 **
114 ** See also: import
115 */
116 void export_cmd(void){
117 Stmt q, q2, q3;
118 int i;
119 Bag blobs, vers;
120
M src/finfo.c
+16 -4
--- src/finfo.c
+++ src/finfo.c
@@ -21,11 +21,11 @@
2121
 #include "finfo.h"
2222
2323
 /*
2424
 ** COMMAND: finfo
2525
 **
26
-** Usage: %fossil finfo {?-l|--log? / -s|--status / --p|--print} FILENAME
26
+** Usage: %fossil finfo ?OPTIONS? FILENAME
2727
 **
2828
 ** Print the complete change history for a single file going backwards
2929
 ** in time. The default is -l.
3030
 **
3131
 ** For the -l|--log option: If "-b|--brief" is specified one line per revision
@@ -34,13 +34,25 @@
3434
 ** after skipping P changes.
3535
 **
3636
 ** In the -s form prints the status as <status> <revision>. This is
3737
 ** a quick status and does not check for up-to-date-ness of the file.
3838
 **
39
-** The -p form, there's an optional flag "-r|--revision REVISION". The
40
-** specified version (or the latest checked out version) is printed to
41
-** stdout.
39
+** In the -p form, there's an optional flag "-r|--revision REVISION".
40
+** The specified version (or the latest checked out version) is printed
41
+** to stdout.
42
+**
43
+** Options:
44
+** --brief|-b display a brief (one line / revision) summary
45
+** --limit N display the first N changes
46
+** --log|-l select log mode (the default)
47
+** --offset P skip P changes
48
+** -p select print mode
49
+** --revision|-r R print the given revision (or ckout, if none is given)
50
+** to stdout (only in print mode)
51
+** -s select status mode (print a status indicator for FILE)
52
+**
53
+** See also: descendants, info, leaves
4254
 */
4355
 void finfo_cmd(void){
4456
 db_must_be_within_tree();
4557
 if (find_option("status","s",0)) {
4658
 Stmt q;
4759
--- src/finfo.c
+++ src/finfo.c
@@ -21,11 +21,11 @@
21 #include "finfo.h"
22
23 /*
24 ** COMMAND: finfo
25 **
26 ** Usage: %fossil finfo {?-l|--log? / -s|--status / --p|--print} FILENAME
27 **
28 ** Print the complete change history for a single file going backwards
29 ** in time. The default is -l.
30 **
31 ** For the -l|--log option: If "-b|--brief" is specified one line per revision
@@ -34,13 +34,25 @@
34 ** after skipping P changes.
35 **
36 ** In the -s form prints the status as <status> <revision>. This is
37 ** a quick status and does not check for up-to-date-ness of the file.
38 **
39 ** The -p form, there's an optional flag "-r|--revision REVISION". The
40 ** specified version (or the latest checked out version) is printed to
41 ** stdout.
 
 
 
 
 
 
 
 
 
 
 
 
42 */
43 void finfo_cmd(void){
44 db_must_be_within_tree();
45 if (find_option("status","s",0)) {
46 Stmt q;
47
--- src/finfo.c
+++ src/finfo.c
@@ -21,11 +21,11 @@
21 #include "finfo.h"
22
23 /*
24 ** COMMAND: finfo
25 **
26 ** Usage: %fossil finfo ?OPTIONS? FILENAME
27 **
28 ** Print the complete change history for a single file going backwards
29 ** in time. The default is -l.
30 **
31 ** For the -l|--log option: If "-b|--brief" is specified one line per revision
@@ -34,13 +34,25 @@
34 ** after skipping P changes.
35 **
36 ** In the -s form prints the status as <status> <revision>. This is
37 ** a quick status and does not check for up-to-date-ness of the file.
38 **
39 ** In the -p form, there's an optional flag "-r|--revision REVISION".
40 ** The specified version (or the latest checked out version) is printed
41 ** to stdout.
42 **
43 ** Options:
44 ** --brief|-b display a brief (one line / revision) summary
45 ** --limit N display the first N changes
46 ** --log|-l select log mode (the default)
47 ** --offset P skip P changes
48 ** -p select print mode
49 ** --revision|-r R print the given revision (or ckout, if none is given)
50 ** to stdout (only in print mode)
51 ** -s select status mode (print a status indicator for FILE)
52 **
53 ** See also: descendants, info, leaves
54 */
55 void finfo_cmd(void){
56 db_must_be_within_tree();
57 if (find_option("status","s",0)) {
58 Stmt q;
59
M src/import.c
+6 -1
--- src/import.c
+++ src/import.c
@@ -701,11 +701,11 @@
701701
 }
702702
703703
 /*
704704
 ** COMMAND: import
705705
 **
706
-** Usage: %fossil import --git NEW-REPOSITORY
706
+** Usage: %fossil import --git ?OPTIONS? NEW-REPOSITORY
707707
 **
708708
 ** Read text generated by the git-fast-export command and use it to
709709
 ** construct a new Fossil repository named by the NEW-REPOSITORY
710710
 ** argument. The git-fast-export text is read from standard input.
711711
 **
@@ -713,10 +713,15 @@
713713
 ** format that is understood, though other interchange formats may be added
714714
 ** in the future.
715715
 **
716716
 ** The --incremental option allows an existing repository to be extended
717717
 ** with new content.
718
+**
719
+** Options:
720
+** --incremental allow importing into an existing repository
721
+**
722
+** See also: export
718723
 */
719724
 void git_import_cmd(void){
720725
 char *zPassword;
721726
 FILE *pIn;
722727
 Stmt q;
723728
--- src/import.c
+++ src/import.c
@@ -701,11 +701,11 @@
701 }
702
703 /*
704 ** COMMAND: import
705 **
706 ** Usage: %fossil import --git NEW-REPOSITORY
707 **
708 ** Read text generated by the git-fast-export command and use it to
709 ** construct a new Fossil repository named by the NEW-REPOSITORY
710 ** argument. The git-fast-export text is read from standard input.
711 **
@@ -713,10 +713,15 @@
713 ** format that is understood, though other interchange formats may be added
714 ** in the future.
715 **
716 ** The --incremental option allows an existing repository to be extended
717 ** with new content.
 
 
 
 
 
718 */
719 void git_import_cmd(void){
720 char *zPassword;
721 FILE *pIn;
722 Stmt q;
723
--- src/import.c
+++ src/import.c
@@ -701,11 +701,11 @@
701 }
702
703 /*
704 ** COMMAND: import
705 **
706 ** Usage: %fossil import --git ?OPTIONS? NEW-REPOSITORY
707 **
708 ** Read text generated by the git-fast-export command and use it to
709 ** construct a new Fossil repository named by the NEW-REPOSITORY
710 ** argument. The git-fast-export text is read from standard input.
711 **
@@ -713,10 +713,15 @@
713 ** format that is understood, though other interchange formats may be added
714 ** in the future.
715 **
716 ** The --incremental option allows an existing repository to be extended
717 ** with new content.
718 **
719 ** Options:
720 ** --incremental allow importing into an existing repository
721 **
722 ** See also: export
723 */
724 void git_import_cmd(void){
725 char *zPassword;
726 FILE *pIn;
727 Stmt q;
728
M src/merge.c
+1 -1
--- src/merge.c
+++ src/merge.c
@@ -24,11 +24,11 @@
2424
2525
2626
 /*
2727
 ** COMMAND: merge
2828
 **
29
-** Usage: %fossil merge [--cherrypick] [--backout] VERSION
29
+** Usage: %fossil merge ?OPTIONS? VERSION
3030
 **
3131
 ** The argument VERSION is a version that should be merged into the
3232
 ** current checkout. All changes from VERSION back to the nearest
3333
 ** common ancestor are merged. Except, if either of the --cherrypick or
3434
 ** --backout options are used only the changes associated with the
3535
--- src/merge.c
+++ src/merge.c
@@ -24,11 +24,11 @@
24
25
26 /*
27 ** COMMAND: merge
28 **
29 ** Usage: %fossil merge [--cherrypick] [--backout] VERSION
30 **
31 ** The argument VERSION is a version that should be merged into the
32 ** current checkout. All changes from VERSION back to the nearest
33 ** common ancestor are merged. Except, if either of the --cherrypick or
34 ** --backout options are used only the changes associated with the
35
--- src/merge.c
+++ src/merge.c
@@ -24,11 +24,11 @@
24
25
26 /*
27 ** COMMAND: merge
28 **
29 ** Usage: %fossil merge ?OPTIONS? VERSION
30 **
31 ** The argument VERSION is a version that should be merged into the
32 ** current checkout. All changes from VERSION back to the nearest
33 ** common ancestor are merged. Except, if either of the --cherrypick or
34 ** --backout options are used only the changes associated with the
35
M src/rebuild.c
+22 -11
--- src/rebuild.c
+++ src/rebuild.c
@@ -485,26 +485,27 @@
485485
 }
486486
487487
 /*
488488
 ** COMMAND: rebuild
489489
 **
490
-** Usage: %fossil rebuild ?REPOSITORY?
490
+** Usage: %fossil rebuild ?REPOSITORY? ?OPTIONS?
491491
 **
492492
 ** Reconstruct the named repository database from the core
493493
 ** records. Run this command after updating the fossil
494494
 ** executable in a way that changes the database schema.
495495
 **
496496
 ** Options:
497
-**
498
-** --noverify Skip the verification of changes to the BLOB table
497
+** --cluster Compute clusters for unclustered artifacts
498
+** --compress Strive to make the database as small as possible
499499
 ** --force Force the rebuild to complete even if errors are seen
500
-** --randomize Scan artifacts in a random order
501
-** --cluster Compute clusters for unclustered artifacts
500
+** --noverify Skip the verification of changes to the BLOB table
502501
 ** --pagesize N Set the database pagesize to N. (512..65536 and power of 2)
502
+** --randomize Scan artifacts in a random order
503
+** --vacuum Run VACUUM on the database after rebuilding
503504
 ** --wal Set Write-Ahead-Log journalling mode on the database
504
-** --compress Strive to make the database as small as possible
505
-** --vacuum Run VACUUM on the database after rebuilding
505
+**
506
+** See also: deconstruct, reconstruct
506507
 */
507508
 void rebuild_database(void){
508509
 int forceFlag;
509510
 int randomizeFlag;
510511
 int errCnt;
@@ -693,11 +694,11 @@
693694
 }
694695
 }
695696
696697
 /*
697698
 ** COMMAND: scrub
698
-** %fossil scrub [--verily] [--force] [--private] [REPOSITORY]
699
+** %fossil scrub ?OPTIONS? ?REPOSITORY?
699700
 **
700701
 ** The command removes sensitive information (such as passwords) from a
701702
 ** repository so that the respository can be sent to an untrusted reader.
702703
 **
703704
 ** By default, only passwords are removed. However, if the --verily option
@@ -709,10 +710,15 @@
709710
 ** This command permanently deletes the scrubbed information. The effects
710711
 ** of this command are irreversible. Use with caution.
711712
 **
712713
 ** The user is prompted to confirm the scrub unless the --force option
713714
 ** is used.
715
+**
716
+** Options:
717
+** --force do not prompt for confirmation
718
+** --private only private branches are removed from the repository
719
+** --verily scrub real thoroughly (see above)
714720
 */
715721
 void scrub_cmd(void){
716722
 int bVerily = find_option("verily",0,0)!=0;
717723
 int bForce = find_option("force", "f", 0)!=0;
718724
 int privateOnly = find_option("private",0,0)!=0;
@@ -829,10 +835,11 @@
829835
 ** This command studies the artifacts (files) in DIRECTORY and
830836
 ** reconstructs the fossil record from them. It places the new
831837
 ** fossil repository in FILENAME. Subdirectories are read, files
832838
 ** with leading '.' in the filename are ignored.
833839
 **
840
+** See also: deconstruct, rebuild
834841
 */
835842
 void reconstruct_cmd(void) {
836843
 char *zPassword;
837844
 if( g.argc!=4 ){
838845
 usage("FILENAME DIRECTORY");
@@ -884,20 +891,24 @@
884891
 /*
885892
 ** COMMAND: deconstruct
886893
 **
887894
 ** Usage %fossil deconstruct ?OPTIONS? DESTINATION
888895
 **
889
-** Options:
890
-** -R|--repository REPOSITORY
891
-** -L|--prefixlength N
892896
 **
893897
 ** This command exports all artifacts of a given repository and
894898
 ** writes all artifacts to the file system. The DESTINATION directory
895899
 ** will be populated with subdirectories AA and files AA/BBBBBBBBB.., where
896900
 ** AABBBBBBBBB.. is the 40 character artifact ID, AA the first 2 characters.
897901
 ** If -L|--prefixlength is given, the length (default 2) of the directory
898902
 ** prefix can be set to 0,1,..,9 characters.
903
+**
904
+** Options:
905
+** -R|--repository REPOSITORY deconstruct given REPOSITORY
906
+** -L|--prefixlength N set the length of the names of the DESTINATION
907
+** subdirectories to N
908
+**
909
+** See also: rebuild, reconstruct
899910
 */
900911
 void deconstruct_cmd(void){
901912
 const char *zDestDir;
902913
 const char *zPrefixOpt;
903914
 Stmt s;
904915
--- src/rebuild.c
+++ src/rebuild.c
@@ -485,26 +485,27 @@
485 }
486
487 /*
488 ** COMMAND: rebuild
489 **
490 ** Usage: %fossil rebuild ?REPOSITORY?
491 **
492 ** Reconstruct the named repository database from the core
493 ** records. Run this command after updating the fossil
494 ** executable in a way that changes the database schema.
495 **
496 ** Options:
497 **
498 ** --noverify Skip the verification of changes to the BLOB table
499 ** --force Force the rebuild to complete even if errors are seen
500 ** --randomize Scan artifacts in a random order
501 ** --cluster Compute clusters for unclustered artifacts
502 ** --pagesize N Set the database pagesize to N. (512..65536 and power of 2)
 
 
503 ** --wal Set Write-Ahead-Log journalling mode on the database
504 ** --compress Strive to make the database as small as possible
505 ** --vacuum Run VACUUM on the database after rebuilding
506 */
507 void rebuild_database(void){
508 int forceFlag;
509 int randomizeFlag;
510 int errCnt;
@@ -693,11 +694,11 @@
693 }
694 }
695
696 /*
697 ** COMMAND: scrub
698 ** %fossil scrub [--verily] [--force] [--private] [REPOSITORY]
699 **
700 ** The command removes sensitive information (such as passwords) from a
701 ** repository so that the respository can be sent to an untrusted reader.
702 **
703 ** By default, only passwords are removed. However, if the --verily option
@@ -709,10 +710,15 @@
709 ** This command permanently deletes the scrubbed information. The effects
710 ** of this command are irreversible. Use with caution.
711 **
712 ** The user is prompted to confirm the scrub unless the --force option
713 ** is used.
 
 
 
 
 
714 */
715 void scrub_cmd(void){
716 int bVerily = find_option("verily",0,0)!=0;
717 int bForce = find_option("force", "f", 0)!=0;
718 int privateOnly = find_option("private",0,0)!=0;
@@ -829,10 +835,11 @@
829 ** This command studies the artifacts (files) in DIRECTORY and
830 ** reconstructs the fossil record from them. It places the new
831 ** fossil repository in FILENAME. Subdirectories are read, files
832 ** with leading '.' in the filename are ignored.
833 **
 
834 */
835 void reconstruct_cmd(void) {
836 char *zPassword;
837 if( g.argc!=4 ){
838 usage("FILENAME DIRECTORY");
@@ -884,20 +891,24 @@
884 /*
885 ** COMMAND: deconstruct
886 **
887 ** Usage %fossil deconstruct ?OPTIONS? DESTINATION
888 **
889 ** Options:
890 ** -R|--repository REPOSITORY
891 ** -L|--prefixlength N
892 **
893 ** This command exports all artifacts of a given repository and
894 ** writes all artifacts to the file system. The DESTINATION directory
895 ** will be populated with subdirectories AA and files AA/BBBBBBBBB.., where
896 ** AABBBBBBBBB.. is the 40 character artifact ID, AA the first 2 characters.
897 ** If -L|--prefixlength is given, the length (default 2) of the directory
898 ** prefix can be set to 0,1,..,9 characters.
 
 
 
 
 
 
 
899 */
900 void deconstruct_cmd(void){
901 const char *zDestDir;
902 const char *zPrefixOpt;
903 Stmt s;
904
--- src/rebuild.c
+++ src/rebuild.c
@@ -485,26 +485,27 @@
485 }
486
487 /*
488 ** COMMAND: rebuild
489 **
490 ** Usage: %fossil rebuild ?REPOSITORY? ?OPTIONS?
491 **
492 ** Reconstruct the named repository database from the core
493 ** records. Run this command after updating the fossil
494 ** executable in a way that changes the database schema.
495 **
496 ** Options:
497 ** --cluster Compute clusters for unclustered artifacts
498 ** --compress Strive to make the database as small as possible
499 ** --force Force the rebuild to complete even if errors are seen
500 ** --noverify Skip the verification of changes to the BLOB table
 
501 ** --pagesize N Set the database pagesize to N. (512..65536 and power of 2)
502 ** --randomize Scan artifacts in a random order
503 ** --vacuum Run VACUUM on the database after rebuilding
504 ** --wal Set Write-Ahead-Log journalling mode on the database
505 **
506 ** See also: deconstruct, reconstruct
507 */
508 void rebuild_database(void){
509 int forceFlag;
510 int randomizeFlag;
511 int errCnt;
@@ -693,11 +694,11 @@
694 }
695 }
696
697 /*
698 ** COMMAND: scrub
699 ** %fossil scrub ?OPTIONS? ?REPOSITORY?
700 **
701 ** The command removes sensitive information (such as passwords) from a
702 ** repository so that the respository can be sent to an untrusted reader.
703 **
704 ** By default, only passwords are removed. However, if the --verily option
@@ -709,10 +710,15 @@
710 ** This command permanently deletes the scrubbed information. The effects
711 ** of this command are irreversible. Use with caution.
712 **
713 ** The user is prompted to confirm the scrub unless the --force option
714 ** is used.
715 **
716 ** Options:
717 ** --force do not prompt for confirmation
718 ** --private only private branches are removed from the repository
719 ** --verily scrub real thoroughly (see above)
720 */
721 void scrub_cmd(void){
722 int bVerily = find_option("verily",0,0)!=0;
723 int bForce = find_option("force", "f", 0)!=0;
724 int privateOnly = find_option("private",0,0)!=0;
@@ -829,10 +835,11 @@
835 ** This command studies the artifacts (files) in DIRECTORY and
836 ** reconstructs the fossil record from them. It places the new
837 ** fossil repository in FILENAME. Subdirectories are read, files
838 ** with leading '.' in the filename are ignored.
839 **
840 ** See also: deconstruct, rebuild
841 */
842 void reconstruct_cmd(void) {
843 char *zPassword;
844 if( g.argc!=4 ){
845 usage("FILENAME DIRECTORY");
@@ -884,20 +891,24 @@
891 /*
892 ** COMMAND: deconstruct
893 **
894 ** Usage %fossil deconstruct ?OPTIONS? DESTINATION
895 **
 
 
 
896 **
897 ** This command exports all artifacts of a given repository and
898 ** writes all artifacts to the file system. The DESTINATION directory
899 ** will be populated with subdirectories AA and files AA/BBBBBBBBB.., where
900 ** AABBBBBBBBB.. is the 40 character artifact ID, AA the first 2 characters.
901 ** If -L|--prefixlength is given, the length (default 2) of the directory
902 ** prefix can be set to 0,1,..,9 characters.
903 **
904 ** Options:
905 ** -R|--repository REPOSITORY deconstruct given REPOSITORY
906 ** -L|--prefixlength N set the length of the names of the DESTINATION
907 ** subdirectories to N
908 **
909 ** See also: rebuild, reconstruct
910 */
911 void deconstruct_cmd(void){
912 const char *zDestDir;
913 const char *zPrefixOpt;
914 Stmt s;
915

Keyboard Shortcuts

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