Fossil SCM
Minor improvements to the new docs.
Commit
2e2e13b9c64d90a55decaeb2307a9789fc363def
Parent
81b76085e52ad86…
1 file changed
+27
-13
+27
-13
| --- www/env-opts.md | ||
| +++ www/env-opts.md | ||
| @@ -31,20 +31,33 @@ | ||
| 31 | 31 | |
| 32 | 32 | `--chdir DIRECTORY`: Change to the named directory before processing |
| 33 | 33 | any commands. |
| 34 | 34 | |
| 35 | 35 | |
| 36 | -`--comfmtflags NUMBER`: Specify flags that control how check-in | |
| 37 | -comments and certain other text outputs are formatted for display. The | |
| 38 | -flags are individual bits in `NUMBER`: | |
| 39 | - | |
| 40 | - 0 no special formatting | |
| 41 | - 1 legacy algorithm (default) | |
| 42 | - 2 trim leading CR and LF | |
| 43 | - 4 trim leading and trailing spaces | |
| 44 | - 8 word break | |
| 45 | - 16 line break before comment | |
| 36 | +`--comfmtflags NUMBER`: Specify flags that control how check-in comments | |
| 37 | +and certain other text outputs are formatted for display. The flags are | |
| 38 | +individual bits in `NUMBER`, which must be specified in base 10: | |
| 39 | + | |
| 40 | + * _0_ — Uses the revised algorithm with no special handling. | |
| 41 | + | |
| 42 | + * _1_ — Uses the legacy algorithm, other flags are ignored. | |
| 43 | + | |
| 44 | + * _2_ — Trims leading and trailing carriage-returns and line-feeds | |
| 45 | + where they do not materially impact pre-existing formatting | |
| 46 | + (i.e. at the start of the comment string -AND- right before | |
| 47 | + line indentation). | |
| 48 | + | |
| 49 | + * _4_ — Trims leading and trailing spaces where they do not materially | |
| 50 | + impact the pre-existing formatting (i.e. at the start of the | |
| 51 | + comment string -AND- right before line indentation). | |
| 52 | + | |
| 53 | + * _8_ — Attempts to break lines on word boundaries while honoring the | |
| 54 | + logical line length. | |
| 55 | + | |
| 56 | + * _10_ — Looks for the original comment text within the text being | |
| 57 | + printed. Upon matching, a new line will be emitted, thus | |
| 58 | + preserving more of the pre-existing formatting. | |
| 46 | 59 | |
| 47 | 60 | |
| 48 | 61 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 49 | 62 | errors, and warnings. |
| 50 | 63 | |
| @@ -210,11 +223,12 @@ | ||
| 210 | 223 | |
| 211 | 224 | `SQLITE_FORCE_PROXY_LOCKING`: From `sqlite3.c`, 1 means force always |
| 212 | 225 | use proxy, 0 means never use proxy, and undefined means use proxy for |
| 213 | 226 | non-local files only. |
| 214 | 227 | |
| 215 | -`SQLITE_TMPDIR`: Names the temporary file location to SQLite. | |
| 228 | +`SQLITE_TMPDIR`: Names the temporary file location for SQLite. When | |
| 229 | +set, this will be used instead of `TMPDIR`. | |
| 216 | 230 | |
| 217 | 231 | |
| 218 | 232 | `SYSTEMROOT`: (Windows) Used to locate `notepad.exe` as a |
| 219 | 233 | fall back comment editor. |
| 220 | 234 | |
| @@ -243,19 +257,19 @@ | ||
| 243 | 257 | |
| 244 | 258 | `TH1_ENABLE_HOOKS`: Override the local or global setting `tcl-hooks` |
| 245 | 259 | to enable TH1 hooks in fossil. |
| 246 | 260 | |
| 247 | 261 | `TH1_ENABLE_TCL`: Override the local or global setting `tcl` to enable |
| 248 | -TCL in fossil. | |
| 262 | +Tcl in fossil. | |
| 249 | 263 | |
| 250 | 264 | `TMP`: On Windows, the location of temporary files. The first |
| 251 | 265 | environment variable found in the environment that names an existing |
| 252 | 266 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 253 | 267 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 254 | 268 | directory (aka `.`) is the temporary folder. |
| 255 | 269 | |
| 256 | -`TMPDIR`: Names the temporary file location to SQLite. | |
| 270 | +`TMPDIR`: Names the temporary file location for SQLite. | |
| 257 | 271 | |
| 258 | 272 | |
| 259 | 273 | `USER`: Name of the logged in user on many Unix-like platforms. |
| 260 | 274 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 261 | 275 | the discussion of Fossil Username below for a lot more detail. |
| 262 | 276 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -31,20 +31,33 @@ | |
| 31 | |
| 32 | `--chdir DIRECTORY`: Change to the named directory before processing |
| 33 | any commands. |
| 34 | |
| 35 | |
| 36 | `--comfmtflags NUMBER`: Specify flags that control how check-in |
| 37 | comments and certain other text outputs are formatted for display. The |
| 38 | flags are individual bits in `NUMBER`: |
| 39 | |
| 40 | 0 no special formatting |
| 41 | 1 legacy algorithm (default) |
| 42 | 2 trim leading CR and LF |
| 43 | 4 trim leading and trailing spaces |
| 44 | 8 word break |
| 45 | 16 line break before comment |
| 46 | |
| 47 | |
| 48 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 49 | errors, and warnings. |
| 50 | |
| @@ -210,11 +223,12 @@ | |
| 210 | |
| 211 | `SQLITE_FORCE_PROXY_LOCKING`: From `sqlite3.c`, 1 means force always |
| 212 | use proxy, 0 means never use proxy, and undefined means use proxy for |
| 213 | non-local files only. |
| 214 | |
| 215 | `SQLITE_TMPDIR`: Names the temporary file location to SQLite. |
| 216 | |
| 217 | |
| 218 | `SYSTEMROOT`: (Windows) Used to locate `notepad.exe` as a |
| 219 | fall back comment editor. |
| 220 | |
| @@ -243,19 +257,19 @@ | |
| 243 | |
| 244 | `TH1_ENABLE_HOOKS`: Override the local or global setting `tcl-hooks` |
| 245 | to enable TH1 hooks in fossil. |
| 246 | |
| 247 | `TH1_ENABLE_TCL`: Override the local or global setting `tcl` to enable |
| 248 | TCL in fossil. |
| 249 | |
| 250 | `TMP`: On Windows, the location of temporary files. The first |
| 251 | environment variable found in the environment that names an existing |
| 252 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 253 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 254 | directory (aka `.`) is the temporary folder. |
| 255 | |
| 256 | `TMPDIR`: Names the temporary file location to SQLite. |
| 257 | |
| 258 | |
| 259 | `USER`: Name of the logged in user on many Unix-like platforms. |
| 260 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 261 | the discussion of Fossil Username below for a lot more detail. |
| 262 |
| --- www/env-opts.md | |
| +++ www/env-opts.md | |
| @@ -31,20 +31,33 @@ | |
| 31 | |
| 32 | `--chdir DIRECTORY`: Change to the named directory before processing |
| 33 | any commands. |
| 34 | |
| 35 | |
| 36 | `--comfmtflags NUMBER`: Specify flags that control how check-in comments |
| 37 | and certain other text outputs are formatted for display. The flags are |
| 38 | individual bits in `NUMBER`, which must be specified in base 10: |
| 39 | |
| 40 | * _0_ — Uses the revised algorithm with no special handling. |
| 41 | |
| 42 | * _1_ — Uses the legacy algorithm, other flags are ignored. |
| 43 | |
| 44 | * _2_ — Trims leading and trailing carriage-returns and line-feeds |
| 45 | where they do not materially impact pre-existing formatting |
| 46 | (i.e. at the start of the comment string -AND- right before |
| 47 | line indentation). |
| 48 | |
| 49 | * _4_ — Trims leading and trailing spaces where they do not materially |
| 50 | impact the pre-existing formatting (i.e. at the start of the |
| 51 | comment string -AND- right before line indentation). |
| 52 | |
| 53 | * _8_ — Attempts to break lines on word boundaries while honoring the |
| 54 | logical line length. |
| 55 | |
| 56 | * _10_ — Looks for the original comment text within the text being |
| 57 | printed. Upon matching, a new line will be emitted, thus |
| 58 | preserving more of the pre-existing formatting. |
| 59 | |
| 60 | |
| 61 | `--errorlog ERRLOG`: Name a file to which fossil will log panics, |
| 62 | errors, and warnings. |
| 63 | |
| @@ -210,11 +223,12 @@ | |
| 223 | |
| 224 | `SQLITE_FORCE_PROXY_LOCKING`: From `sqlite3.c`, 1 means force always |
| 225 | use proxy, 0 means never use proxy, and undefined means use proxy for |
| 226 | non-local files only. |
| 227 | |
| 228 | `SQLITE_TMPDIR`: Names the temporary file location for SQLite. When |
| 229 | set, this will be used instead of `TMPDIR`. |
| 230 | |
| 231 | |
| 232 | `SYSTEMROOT`: (Windows) Used to locate `notepad.exe` as a |
| 233 | fall back comment editor. |
| 234 | |
| @@ -243,19 +257,19 @@ | |
| 257 | |
| 258 | `TH1_ENABLE_HOOKS`: Override the local or global setting `tcl-hooks` |
| 259 | to enable TH1 hooks in fossil. |
| 260 | |
| 261 | `TH1_ENABLE_TCL`: Override the local or global setting `tcl` to enable |
| 262 | Tcl in fossil. |
| 263 | |
| 264 | `TMP`: On Windows, the location of temporary files. The first |
| 265 | environment variable found in the environment that names an existing |
| 266 | directory from the list `TMP`, `TEMP`, `USERPROFILE`, the Windows |
| 267 | directory (usually `C:\WINDOWS`), `TEMP`, `TMP`, and the current |
| 268 | directory (aka `.`) is the temporary folder. |
| 269 | |
| 270 | `TMPDIR`: Names the temporary file location for SQLite. |
| 271 | |
| 272 | |
| 273 | `USER`: Name of the logged in user on many Unix-like platforms. |
| 274 | Used as the fossil user name if `FOSSIL_USER` is not specified. See |
| 275 | the discussion of Fossil Username below for a lot more detail. |
| 276 |