Fossil SCM
Add a brief note to the commit help mentioning that checkin messages are processed as fossil-wiki format, as recommended in [forum:a78e65b082|forum post a78e65b082]. Also clarify _why_ --branchcolo/--bgcolor are not recommended.
Commit
4c62db1870fcc7d5503e3a8294edabcf63fe8d630622c1180f810f67c86d9027
Parent
d96055cc33aa98f…
1 file changed
+9
-6
+9
-6
| --- src/checkin.c | ||
| +++ src/checkin.c | ||
| @@ -2349,11 +2349,12 @@ | ||
| 2349 | 2349 | ** check-out. You will be prompted to enter a check-in comment unless |
| 2350 | 2350 | ** the comment has been specified on the command-line using "-m" or a |
| 2351 | 2351 | ** file containing the comment using -M. The editor defined in the |
| 2352 | 2352 | ** "editor" fossil option (see %fossil help set) will be used, or from |
| 2353 | 2353 | ** the "VISUAL" or "EDITOR" environment variables (in that order) if |
| 2354 | -** no editor is set. | |
| 2354 | +** no editor is set. Commit message text is interpreted as fossil-wiki | |
| 2355 | +** format. | |
| 2355 | 2356 | ** |
| 2356 | 2357 | ** All files that have changed will be committed unless some subset of |
| 2357 | 2358 | ** files is specified on the command line. |
| 2358 | 2359 | ** |
| 2359 | 2360 | ** The --branch option followed by a branch name causes the new |
| @@ -2360,17 +2361,19 @@ | ||
| 2360 | 2361 | ** check-in to be placed in a newly-created branch with the name |
| 2361 | 2362 | ** passed to the --branch option. |
| 2362 | 2363 | ** |
| 2363 | 2364 | ** Use the --branchcolor option followed by a color name (ex: |
| 2364 | 2365 | ** '#ffc0c0') to specify the background color of entries in the new |
| 2365 | -** branch when shown in the web timeline interface. The use of | |
| 2366 | -** the --branchcolor option is not recommended. Instead, let Fossil | |
| 2367 | -** choose the branch color automatically. | |
| 2366 | +** branch when shown in the web timeline interface. The use of the | |
| 2367 | +** --branchcolor option is not recommended because user-selected | |
| 2368 | +** colors may not interact well with all site skins. Instead, let | |
| 2369 | +** Fossil choose the branch color automatically. | |
| 2368 | 2370 | ** |
| 2369 | 2371 | ** The --bgcolor option works like --branchcolor but only sets the |
| 2370 | -** background color for a single check-in. Subsequent check-ins revert | |
| 2371 | -** to the default color. | |
| 2372 | +** background color for a single check-in. Subsequent check-ins | |
| 2373 | +** revert to the default color. --bgcolor is not recommended for the | |
| 2374 | +** same reason that --branchcolor is not recommended. | |
| 2372 | 2375 | ** |
| 2373 | 2376 | ** A check-in is not permitted to fork unless the --allow-fork option |
| 2374 | 2377 | ** appears. An empty check-in (i.e. with nothing changed) is not |
| 2375 | 2378 | ** allowed unless the --allow-empty option appears. A check-in may not |
| 2376 | 2379 | ** be older than its ancestor unless the --allow-older option appears. |
| 2377 | 2380 |
| --- src/checkin.c | |
| +++ src/checkin.c | |
| @@ -2349,11 +2349,12 @@ | |
| 2349 | ** check-out. You will be prompted to enter a check-in comment unless |
| 2350 | ** the comment has been specified on the command-line using "-m" or a |
| 2351 | ** file containing the comment using -M. The editor defined in the |
| 2352 | ** "editor" fossil option (see %fossil help set) will be used, or from |
| 2353 | ** the "VISUAL" or "EDITOR" environment variables (in that order) if |
| 2354 | ** no editor is set. |
| 2355 | ** |
| 2356 | ** All files that have changed will be committed unless some subset of |
| 2357 | ** files is specified on the command line. |
| 2358 | ** |
| 2359 | ** The --branch option followed by a branch name causes the new |
| @@ -2360,17 +2361,19 @@ | |
| 2360 | ** check-in to be placed in a newly-created branch with the name |
| 2361 | ** passed to the --branch option. |
| 2362 | ** |
| 2363 | ** Use the --branchcolor option followed by a color name (ex: |
| 2364 | ** '#ffc0c0') to specify the background color of entries in the new |
| 2365 | ** branch when shown in the web timeline interface. The use of |
| 2366 | ** the --branchcolor option is not recommended. Instead, let Fossil |
| 2367 | ** choose the branch color automatically. |
| 2368 | ** |
| 2369 | ** The --bgcolor option works like --branchcolor but only sets the |
| 2370 | ** background color for a single check-in. Subsequent check-ins revert |
| 2371 | ** to the default color. |
| 2372 | ** |
| 2373 | ** A check-in is not permitted to fork unless the --allow-fork option |
| 2374 | ** appears. An empty check-in (i.e. with nothing changed) is not |
| 2375 | ** allowed unless the --allow-empty option appears. A check-in may not |
| 2376 | ** be older than its ancestor unless the --allow-older option appears. |
| 2377 |
| --- src/checkin.c | |
| +++ src/checkin.c | |
| @@ -2349,11 +2349,12 @@ | |
| 2349 | ** check-out. You will be prompted to enter a check-in comment unless |
| 2350 | ** the comment has been specified on the command-line using "-m" or a |
| 2351 | ** file containing the comment using -M. The editor defined in the |
| 2352 | ** "editor" fossil option (see %fossil help set) will be used, or from |
| 2353 | ** the "VISUAL" or "EDITOR" environment variables (in that order) if |
| 2354 | ** no editor is set. Commit message text is interpreted as fossil-wiki |
| 2355 | ** format. |
| 2356 | ** |
| 2357 | ** All files that have changed will be committed unless some subset of |
| 2358 | ** files is specified on the command line. |
| 2359 | ** |
| 2360 | ** The --branch option followed by a branch name causes the new |
| @@ -2360,17 +2361,19 @@ | |
| 2361 | ** check-in to be placed in a newly-created branch with the name |
| 2362 | ** passed to the --branch option. |
| 2363 | ** |
| 2364 | ** Use the --branchcolor option followed by a color name (ex: |
| 2365 | ** '#ffc0c0') to specify the background color of entries in the new |
| 2366 | ** branch when shown in the web timeline interface. The use of the |
| 2367 | ** --branchcolor option is not recommended because user-selected |
| 2368 | ** colors may not interact well with all site skins. Instead, let |
| 2369 | ** Fossil choose the branch color automatically. |
| 2370 | ** |
| 2371 | ** The --bgcolor option works like --branchcolor but only sets the |
| 2372 | ** background color for a single check-in. Subsequent check-ins |
| 2373 | ** revert to the default color. --bgcolor is not recommended for the |
| 2374 | ** same reason that --branchcolor is not recommended. |
| 2375 | ** |
| 2376 | ** A check-in is not permitted to fork unless the --allow-fork option |
| 2377 | ** appears. An empty check-in (i.e. with nothing changed) is not |
| 2378 | ** allowed unless the --allow-empty option appears. A check-in may not |
| 2379 | ** be older than its ancestor unless the --allow-older option appears. |
| 2380 |