Fossil SCM
Update the Environment Variables and Global Options document and the Change Log to reflect current development. (Plus an unrelated formatting fix in the first document.)
Commit
007fd18d69950eb8817d0d75a75e1796248ac66d50aebbd050cb4716d39f52f4
Parent
6382e25428ddca1…
2 files changed
+3
-2
+12
-3
+3
-2
| --- www/changes.wiki | ||
| +++ www/changes.wiki | ||
| @@ -19,12 +19,13 @@ | ||
| 19 | 19 | branch has been changed. |
| 20 | 20 | * When a merge conflict occurs, a new section is added to the conflict |
| 21 | 21 | text that shows Fossil's suggested resolution to the conflict. |
| 22 | 22 | * Add the "Hide diffs/Show diffs" toggle to web-UI diff pages that show |
| 23 | 23 | diffs of multiple files. |
| 24 | - * Remove the --comfmtflags and --comment-format global options, which | |
| 25 | - as far as I can tell are never used, but do add unnecessary complexity. | |
| 24 | + * Deprecate the --comfmtflags and --comment-format global options and | |
| 25 | + no longer list them in the built-in help, but keep them working for | |
| 26 | + backwards compatibility. | |
| 26 | 27 | Alternative TTY comment formatting can still be specified using the |
| 27 | 28 | [/help?cmd=comment-format|comment-format setting], if desired. The |
| 28 | 29 | default comment format is now called "canonical", not "legacy". |
| 29 | 30 | * Enhancements to the [/help?cmd=/timeline|/timeline page]: |
| 30 | 31 | <ol type="a"> |
| 31 | 32 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -19,12 +19,13 @@ | |
| 19 | branch has been changed. |
| 20 | * When a merge conflict occurs, a new section is added to the conflict |
| 21 | text that shows Fossil's suggested resolution to the conflict. |
| 22 | * Add the "Hide diffs/Show diffs" toggle to web-UI diff pages that show |
| 23 | diffs of multiple files. |
| 24 | * Remove the --comfmtflags and --comment-format global options, which |
| 25 | as far as I can tell are never used, but do add unnecessary complexity. |
| 26 | Alternative TTY comment formatting can still be specified using the |
| 27 | [/help?cmd=comment-format|comment-format setting], if desired. The |
| 28 | default comment format is now called "canonical", not "legacy". |
| 29 | * Enhancements to the [/help?cmd=/timeline|/timeline page]: |
| 30 | <ol type="a"> |
| 31 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -19,12 +19,13 @@ | |
| 19 | branch has been changed. |
| 20 | * When a merge conflict occurs, a new section is added to the conflict |
| 21 | text that shows Fossil's suggested resolution to the conflict. |
| 22 | * Add the "Hide diffs/Show diffs" toggle to web-UI diff pages that show |
| 23 | diffs of multiple files. |
| 24 | * Deprecate the --comfmtflags and --comment-format global options and |
| 25 | no longer list them in the built-in help, but keep them working for |
| 26 | backwards compatibility. |
| 27 | Alternative TTY comment formatting can still be specified using the |
| 28 | [/help?cmd=comment-format|comment-format setting], if desired. The |
| 29 | default comment format is now called "canonical", not "legacy". |
| 30 | * Enhancements to the [/help?cmd=/timeline|/timeline page]: |
| 31 | <ol type="a"> |
| 32 |
+12
-3
| --- www/env-opts.md | ||
| +++ www/env-opts.md | ||
| @@ -39,11 +39,11 @@ | ||
| 39 | 39 | and certain other text outputs are formatted for display. The flags are |
| 40 | 40 | individual bits in `NUMBER`, which must be specified in base 10: |
| 41 | 41 | |
| 42 | 42 | * _0_ — Uses the revised algorithm with no special handling. |
| 43 | 43 | |
| 44 | - * _1_ — Uses the legacy algorithm, other flags are ignored. | |
| 44 | + * _1_ — Uses the canonical algorithm, other flags are ignored. | |
| 45 | 45 | |
| 46 | 46 | * _2_ — Trims leading and trailing carriage-returns and line-feeds |
| 47 | 47 | where they do not materially impact pre-existing formatting |
| 48 | 48 | (i.e. at the start of the comment string _and_ right before |
| 49 | 49 | line indentation). |
| @@ -60,10 +60,15 @@ | ||
| 60 | 60 | preserving more of the pre-existing formatting. |
| 61 | 61 | |
| 62 | 62 | |
| 63 | 63 | `--comment-format NUMBER`: Alias for `--comfmtflags NUMBER`. |
| 64 | 64 | |
| 65 | + | |
| 66 | +> NOTE: As of Fossil version 2.26, use of the `--comfmtflags` and | |
| 67 | +> `--comment-format` options is no longer recommended and they are | |
| 68 | +> no longer documented, but retained for backwards compatibility. | |
| 69 | + | |
| 65 | 70 | |
| 66 | 71 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 67 | 72 | errors, and warnings. |
| 68 | 73 | |
| 69 | 74 | |
| @@ -210,10 +215,14 @@ | ||
| 210 | 215 | used as the location of the `~/.fossil` file. |
| 211 | 216 | |
| 212 | 217 | `LOGNAME`: Name of the logged in user on many Unix-like platforms. |
| 213 | 218 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 214 | 219 | the discussion of Fossil Username below for a lot more detail. |
| 220 | + | |
| 221 | +`NO_COLOR`: If defined and not set to a `false` value (i.e. "off", "no", | |
| 222 | +"false", "0"), the `fossil search` command skips colorization of console | |
| 223 | +output using ANSI escape codes (VT100). | |
| 215 | 224 | |
| 216 | 225 | `PATH`: Used by most platforms to locate programs invoked without a |
| 217 | 226 | fully qualified name. Explicitly used by `fossil ui` on certain platforms |
| 218 | 227 | to choose the browser to launch. |
| 219 | 228 | |
| @@ -464,12 +473,12 @@ | ||
| 464 | 473 | |
| 465 | 474 | ### Web browser |
| 466 | 475 | |
| 467 | 476 | Occasionally, fossil wants to launch a web browser for the user, most |
| 468 | 477 | obviously as part of the `fossil ui` command. In that specific case, |
| 469 | -the browser is launched pointing at the web server started by `fossil | |
| 470 | -ui` listening on a private TCP port. | |
| 478 | +the browser is launched pointing at the web server started by | |
| 479 | +`fossil ui` listening on a private TCP port. | |
| 471 | 480 | |
| 472 | 481 | On all platforms, if the local or global settings `web-browser` is |
| 473 | 482 | set, that is the command used to open a URL. |
| 474 | 483 | |
| 475 | 484 | Otherwise, the specific actions vary by platform. |
| 476 | 485 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -39,11 +39,11 @@ | |
| 39 | and certain other text outputs are formatted for display. The flags are |
| 40 | individual bits in `NUMBER`, which must be specified in base 10: |
| 41 | |
| 42 | * _0_ — Uses the revised algorithm with no special handling. |
| 43 | |
| 44 | * _1_ — Uses the legacy algorithm, other flags are ignored. |
| 45 | |
| 46 | * _2_ — Trims leading and trailing carriage-returns and line-feeds |
| 47 | where they do not materially impact pre-existing formatting |
| 48 | (i.e. at the start of the comment string _and_ right before |
| 49 | line indentation). |
| @@ -60,10 +60,15 @@ | |
| 60 | preserving more of the pre-existing formatting. |
| 61 | |
| 62 | |
| 63 | `--comment-format NUMBER`: Alias for `--comfmtflags NUMBER`. |
| 64 | |
| 65 | |
| 66 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 67 | errors, and warnings. |
| 68 | |
| 69 | |
| @@ -210,10 +215,14 @@ | |
| 210 | used as the location of the `~/.fossil` file. |
| 211 | |
| 212 | `LOGNAME`: Name of the logged in user on many Unix-like platforms. |
| 213 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 214 | the discussion of Fossil Username below for a lot more detail. |
| 215 | |
| 216 | `PATH`: Used by most platforms to locate programs invoked without a |
| 217 | fully qualified name. Explicitly used by `fossil ui` on certain platforms |
| 218 | to choose the browser to launch. |
| 219 | |
| @@ -464,12 +473,12 @@ | |
| 464 | |
| 465 | ### Web browser |
| 466 | |
| 467 | Occasionally, fossil wants to launch a web browser for the user, most |
| 468 | obviously as part of the `fossil ui` command. In that specific case, |
| 469 | the browser is launched pointing at the web server started by `fossil |
| 470 | ui` listening on a private TCP port. |
| 471 | |
| 472 | On all platforms, if the local or global settings `web-browser` is |
| 473 | set, that is the command used to open a URL. |
| 474 | |
| 475 | Otherwise, the specific actions vary by platform. |
| 476 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -39,11 +39,11 @@ | |
| 39 | and certain other text outputs are formatted for display. The flags are |
| 40 | individual bits in `NUMBER`, which must be specified in base 10: |
| 41 | |
| 42 | * _0_ — Uses the revised algorithm with no special handling. |
| 43 | |
| 44 | * _1_ — Uses the canonical algorithm, other flags are ignored. |
| 45 | |
| 46 | * _2_ — Trims leading and trailing carriage-returns and line-feeds |
| 47 | where they do not materially impact pre-existing formatting |
| 48 | (i.e. at the start of the comment string _and_ right before |
| 49 | line indentation). |
| @@ -60,10 +60,15 @@ | |
| 60 | preserving more of the pre-existing formatting. |
| 61 | |
| 62 | |
| 63 | `--comment-format NUMBER`: Alias for `--comfmtflags NUMBER`. |
| 64 | |
| 65 | |
| 66 | > NOTE: As of Fossil version 2.26, use of the `--comfmtflags` and |
| 67 | > `--comment-format` options is no longer recommended and they are |
| 68 | > no longer documented, but retained for backwards compatibility. |
| 69 | |
| 70 | |
| 71 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 72 | errors, and warnings. |
| 73 | |
| 74 | |
| @@ -210,10 +215,14 @@ | |
| 215 | used as the location of the `~/.fossil` file. |
| 216 | |
| 217 | `LOGNAME`: Name of the logged in user on many Unix-like platforms. |
| 218 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 219 | the discussion of Fossil Username below for a lot more detail. |
| 220 | |
| 221 | `NO_COLOR`: If defined and not set to a `false` value (i.e. "off", "no", |
| 222 | "false", "0"), the `fossil search` command skips colorization of console |
| 223 | output using ANSI escape codes (VT100). |
| 224 | |
| 225 | `PATH`: Used by most platforms to locate programs invoked without a |
| 226 | fully qualified name. Explicitly used by `fossil ui` on certain platforms |
| 227 | to choose the browser to launch. |
| 228 | |
| @@ -464,12 +473,12 @@ | |
| 473 | |
| 474 | ### Web browser |
| 475 | |
| 476 | Occasionally, fossil wants to launch a web browser for the user, most |
| 477 | obviously as part of the `fossil ui` command. In that specific case, |
| 478 | the browser is launched pointing at the web server started by |
| 479 | `fossil ui` listening on a private TCP port. |
| 480 | |
| 481 | On all platforms, if the local or global settings `web-browser` is |
| 482 | set, that is the command used to open a URL. |
| 483 | |
| 484 | Otherwise, the specific actions vary by platform. |
| 485 |