Fossil SCM

Enhance the "fossil checkout" documentation to discourage newbies from using it.

drh 2021-01-14 23:51 trunk
Commit 1bdd48532d74a9cc613540e40460f09120d7552a7811fec5cbefc360c172a00d
1 file changed +8 -3
+8 -3
--- src/checkout.c
+++ src/checkout.c
@@ -262,13 +262,18 @@
262262
** COMMAND: co*
263263
**
264264
** Usage: %fossil checkout ?VERSION | --latest? ?OPTIONS?
265265
** or: %fossil co ?VERSION | --latest? ?OPTIONS?
266266
**
267
-** Check out a version specified on the command-line. This command
268
-** will abort if there are edited files in the current checkout unless
269
-** the --force option appears on the command-line. The --keep option
267
+** NOTE: Most people use "fossil update" instead of "fossil checkout" for
268
+** day-to-day operations. If you are new to Fossil and trying to learn your
269
+** way around, it is recommended that you become familiar with the
270
+** "fossil update" command first.
271
+**
272
+** This command changes the current check-out to the version specified
273
+** as an argument. The command aborts if there are edited files in the
274
+** current checkout unless the --force option is used. The --keep option
270275
** leaves files on disk unchanged, except the manifest and manifest.uuid
271276
** files.
272277
**
273278
** The --latest flag can be used in place of VERSION to checkout the
274279
** latest version in the repository.
275280
--- src/checkout.c
+++ src/checkout.c
@@ -262,13 +262,18 @@
262 ** COMMAND: co*
263 **
264 ** Usage: %fossil checkout ?VERSION | --latest? ?OPTIONS?
265 ** or: %fossil co ?VERSION | --latest? ?OPTIONS?
266 **
267 ** Check out a version specified on the command-line. This command
268 ** will abort if there are edited files in the current checkout unless
269 ** the --force option appears on the command-line. The --keep option
 
 
 
 
 
270 ** leaves files on disk unchanged, except the manifest and manifest.uuid
271 ** files.
272 **
273 ** The --latest flag can be used in place of VERSION to checkout the
274 ** latest version in the repository.
275
--- src/checkout.c
+++ src/checkout.c
@@ -262,13 +262,18 @@
262 ** COMMAND: co*
263 **
264 ** Usage: %fossil checkout ?VERSION | --latest? ?OPTIONS?
265 ** or: %fossil co ?VERSION | --latest? ?OPTIONS?
266 **
267 ** NOTE: Most people use "fossil update" instead of "fossil checkout" for
268 ** day-to-day operations. If you are new to Fossil and trying to learn your
269 ** way around, it is recommended that you become familiar with the
270 ** "fossil update" command first.
271 **
272 ** This command changes the current check-out to the version specified
273 ** as an argument. The command aborts if there are edited files in the
274 ** current checkout unless the --force option is used. The --keep option
275 ** leaves files on disk unchanged, except the manifest and manifest.uuid
276 ** files.
277 **
278 ** The --latest flag can be used in place of VERSION to checkout the
279 ** latest version in the repository.
280

Keyboard Shortcuts

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