Fossil SCM
Added a few named anchors to the globs doc, added a mention of the new empty-dirs handling, and improved the internal MD markup style.
Commit
b293b265a695c995479884dc086f606c383f1dfb431b99eb01427f5b7c758e95
Parent
2c0b70eb5a758dd…
1 file changed
+28
-23
+28
-23
| --- www/globs.md | ||
| +++ www/globs.md | ||
| @@ -18,11 +18,11 @@ | ||
| 18 | 18 | |
| 19 | 19 | [glob]: https://en.wikipedia.org/wiki/Glob_(programming) |
| 20 | 20 | [greinc]: https://unix.stackexchange.com/a/57958/138 |
| 21 | 21 | [regexp]: https://en.wikipedia.org/wiki/Regular_expression |
| 22 | 22 | |
| 23 | -Fossil’s `*-glob` settings hold one or more patterns to cause Fossil to | |
| 23 | +[Fossil’s `*-glob` settings](#settings) hold one or more patterns to cause Fossil to | |
| 24 | 24 | give matching named files special treatment. Glob patterns are also |
| 25 | 25 | accepted in options to certain commands and as query parameters to |
| 26 | 26 | certain Fossil UI web pages. For consistency, settings such as |
| 27 | 27 | `empty-dirs` are parsed as a glob even though they aren’t then *applied* |
| 28 | 28 | as a glob since it allows [the same syntax rules](#syntax) to apply. |
| @@ -163,14 +163,15 @@ | ||
| 163 | 163 | `README` | Matches only a file named `README` in the root of the tree. It does not match a file named `src/README` because it does not include any characters that consume (and match) the `src/` part. |
| 164 | 164 | `*/README` | Matches `src/README`. Unlike Unix file globs, it also matches `src/library/README`. However it does not match the file `README` in the root of the tree. |
| 165 | 165 | `*README` | Matches `src/README` as well as the file `README` in the root of the tree as well as `foo/bar/README` or any other file named `README` in the tree. However, it also matches `A-DIFFERENT-README` and `src/DO-NOT-README`, or any other file whose name ends with `README`. |
| 166 | 166 | `src/README` | Matches `src\README` on Windows because all directory separators are rewritten as `/` in the canonical name before the glob is matched. This makes it much easier to write globs that work on both Unix and Windows. |
| 167 | 167 | `*.[ch]` | Matches every C source or header file in the tree at the root or at any depth. Again, this is (deliberately) different from Unix file globs and Windows wild cards. |
| 168 | + | |
| 168 | 169 | |
| 169 | 170 | ## Where Globs are Used |
| 170 | 171 | |
| 171 | -### Settings that are Globs | |
| 172 | +### <a id="settings"></a>Settings that are Globs | |
| 172 | 173 | |
| 173 | 174 | These settings are all lists of glob patterns: |
| 174 | 175 | |
| 175 | 176 | :Setting |:Description |
| 176 | 177 | -------------------------------------------------------------------------------- |
| @@ -197,12 +198,16 @@ | ||
| 197 | 198 | commands. This is especially true when one (or more) IDEs are used in |
| 198 | 199 | a project because each IDE has its own ideas of how and where to cache |
| 199 | 200 | information that speeds up its browsing and building tasks but which |
| 200 | 201 | need not be preserved in your project's history. |
| 201 | 202 | |
| 203 | +Although the `empty-dirs` setting is not a list of glob patterns as | |
| 204 | +such, it is *parsed* that way for consistency among the settings, | |
| 205 | +allowing [the list parsing rules above](#syntax) to apply. | |
| 202 | 206 | |
| 203 | -### Commands that Refer to Globs | |
| 207 | + | |
| 208 | +### <a id="commands"></a>Commands that Refer to Globs | |
| 204 | 209 | |
| 205 | 210 | Many of the commands that respect the settings containing globs have |
| 206 | 211 | options to override some or all of the settings. These options are |
| 207 | 212 | usually named to correspond to the setting they override, such as |
| 208 | 213 | `--ignore` to override the `ignore-glob` setting. These commands are: |
| @@ -227,29 +232,29 @@ | ||
| 227 | 232 | The commands [`http`][], [`cgi`][], [`server`][], and [`ui`][] that |
| 228 | 233 | implement or support with web servers provide a mechanism to name some |
| 229 | 234 | files to serve with static content where a list of glob patterns |
| 230 | 235 | specifies what content may be served. |
| 231 | 236 | |
| 232 | -[`add`]: /help?cmd=add | |
| 237 | +[`add`]: /help?cmd=add | |
| 233 | 238 | [`addremove`]: /help?cmd=addremove |
| 234 | -[`changes`]: /help?cmd=changes | |
| 235 | -[`clean`]: /help?cmd=clean | |
| 236 | -[`commit`]: /help?cmd=commit | |
| 237 | -[`extras`]: /help?cmd=extras | |
| 238 | -[`merge`]: /help?cmd=merge | |
| 239 | -[`settings`]: /help?cmd=settings | |
| 240 | -[`status`]: /help?cmd=status | |
| 241 | -[`touch`]: /help?cmd=touch | |
| 242 | -[`unset`]: /help?cmd=unset | |
| 243 | - | |
| 244 | -[`tarball`]: /help?cmd=tarball | |
| 245 | -[`zip`]: /help?cmd=zip | |
| 246 | - | |
| 247 | -[`http`]: /help?cmd=http | |
| 248 | -[`cgi`]: /help?cmd=cgi | |
| 249 | -[`server`]: /help?cmd=server | |
| 250 | -[`ui`]: /help?cmd=ui | |
| 239 | +[`changes`]: /help?cmd=changes | |
| 240 | +[`clean`]: /help?cmd=clean | |
| 241 | +[`commit`]: /help?cmd=commit | |
| 242 | +[`extras`]: /help?cmd=extras | |
| 243 | +[`merge`]: /help?cmd=merge | |
| 244 | +[`settings`]: /help?cmd=settings | |
| 245 | +[`status`]: /help?cmd=status | |
| 246 | +[`touch`]: /help?cmd=touch | |
| 247 | +[`unset`]: /help?cmd=unset | |
| 248 | + | |
| 249 | +[`tarball`]: /help?cmd=tarball | |
| 250 | +[`zip`]: /help?cmd=zip | |
| 251 | + | |
| 252 | +[`http`]: /help?cmd=http | |
| 253 | +[`cgi`]: /help?cmd=cgi | |
| 254 | +[`server`]: /help?cmd=server | |
| 255 | +[`ui`]: /help?cmd=ui | |
| 251 | 256 | |
| 252 | 257 | |
| 253 | 258 | ### Web Pages that Refer to Globs |
| 254 | 259 | |
| 255 | 260 | The [`/timeline`][] page supports the query parameter `chng=GLOBLIST` that |
| @@ -263,12 +268,12 @@ | ||
| 263 | 268 | of a specific checkin. They may be further restricted by query |
| 264 | 269 | parameters that specify glob patterns that name files to include or |
| 265 | 270 | exclude rather than taking the entire checkin. |
| 266 | 271 | |
| 267 | 272 | [`/timeline`]: /help?cmd=/timeline |
| 268 | -[`/tarball`]: /help?cmd=/tarball | |
| 269 | -[`/zip`]: /help?cmd=/zip | |
| 273 | +[`/tarball`]: /help?cmd=/tarball | |
| 274 | +[`/zip`]: /help?cmd=/zip | |
| 270 | 275 | |
| 271 | 276 | |
| 272 | 277 | ## Platform Quirks |
| 273 | 278 | |
| 274 | 279 | Fossil glob patterns are based on the glob pattern feature of POSIX |
| 275 | 280 |
| --- www/globs.md | |
| +++ www/globs.md | |
| @@ -18,11 +18,11 @@ | |
| 18 | |
| 19 | [glob]: https://en.wikipedia.org/wiki/Glob_(programming) |
| 20 | [greinc]: https://unix.stackexchange.com/a/57958/138 |
| 21 | [regexp]: https://en.wikipedia.org/wiki/Regular_expression |
| 22 | |
| 23 | Fossil’s `*-glob` settings hold one or more patterns to cause Fossil to |
| 24 | give matching named files special treatment. Glob patterns are also |
| 25 | accepted in options to certain commands and as query parameters to |
| 26 | certain Fossil UI web pages. For consistency, settings such as |
| 27 | `empty-dirs` are parsed as a glob even though they aren’t then *applied* |
| 28 | as a glob since it allows [the same syntax rules](#syntax) to apply. |
| @@ -163,14 +163,15 @@ | |
| 163 | `README` | Matches only a file named `README` in the root of the tree. It does not match a file named `src/README` because it does not include any characters that consume (and match) the `src/` part. |
| 164 | `*/README` | Matches `src/README`. Unlike Unix file globs, it also matches `src/library/README`. However it does not match the file `README` in the root of the tree. |
| 165 | `*README` | Matches `src/README` as well as the file `README` in the root of the tree as well as `foo/bar/README` or any other file named `README` in the tree. However, it also matches `A-DIFFERENT-README` and `src/DO-NOT-README`, or any other file whose name ends with `README`. |
| 166 | `src/README` | Matches `src\README` on Windows because all directory separators are rewritten as `/` in the canonical name before the glob is matched. This makes it much easier to write globs that work on both Unix and Windows. |
| 167 | `*.[ch]` | Matches every C source or header file in the tree at the root or at any depth. Again, this is (deliberately) different from Unix file globs and Windows wild cards. |
| 168 | |
| 169 | ## Where Globs are Used |
| 170 | |
| 171 | ### Settings that are Globs |
| 172 | |
| 173 | These settings are all lists of glob patterns: |
| 174 | |
| 175 | :Setting |:Description |
| 176 | -------------------------------------------------------------------------------- |
| @@ -197,12 +198,16 @@ | |
| 197 | commands. This is especially true when one (or more) IDEs are used in |
| 198 | a project because each IDE has its own ideas of how and where to cache |
| 199 | information that speeds up its browsing and building tasks but which |
| 200 | need not be preserved in your project's history. |
| 201 | |
| 202 | |
| 203 | ### Commands that Refer to Globs |
| 204 | |
| 205 | Many of the commands that respect the settings containing globs have |
| 206 | options to override some or all of the settings. These options are |
| 207 | usually named to correspond to the setting they override, such as |
| 208 | `--ignore` to override the `ignore-glob` setting. These commands are: |
| @@ -227,29 +232,29 @@ | |
| 227 | The commands [`http`][], [`cgi`][], [`server`][], and [`ui`][] that |
| 228 | implement or support with web servers provide a mechanism to name some |
| 229 | files to serve with static content where a list of glob patterns |
| 230 | specifies what content may be served. |
| 231 | |
| 232 | [`add`]: /help?cmd=add |
| 233 | [`addremove`]: /help?cmd=addremove |
| 234 | [`changes`]: /help?cmd=changes |
| 235 | [`clean`]: /help?cmd=clean |
| 236 | [`commit`]: /help?cmd=commit |
| 237 | [`extras`]: /help?cmd=extras |
| 238 | [`merge`]: /help?cmd=merge |
| 239 | [`settings`]: /help?cmd=settings |
| 240 | [`status`]: /help?cmd=status |
| 241 | [`touch`]: /help?cmd=touch |
| 242 | [`unset`]: /help?cmd=unset |
| 243 | |
| 244 | [`tarball`]: /help?cmd=tarball |
| 245 | [`zip`]: /help?cmd=zip |
| 246 | |
| 247 | [`http`]: /help?cmd=http |
| 248 | [`cgi`]: /help?cmd=cgi |
| 249 | [`server`]: /help?cmd=server |
| 250 | [`ui`]: /help?cmd=ui |
| 251 | |
| 252 | |
| 253 | ### Web Pages that Refer to Globs |
| 254 | |
| 255 | The [`/timeline`][] page supports the query parameter `chng=GLOBLIST` that |
| @@ -263,12 +268,12 @@ | |
| 263 | of a specific checkin. They may be further restricted by query |
| 264 | parameters that specify glob patterns that name files to include or |
| 265 | exclude rather than taking the entire checkin. |
| 266 | |
| 267 | [`/timeline`]: /help?cmd=/timeline |
| 268 | [`/tarball`]: /help?cmd=/tarball |
| 269 | [`/zip`]: /help?cmd=/zip |
| 270 | |
| 271 | |
| 272 | ## Platform Quirks |
| 273 | |
| 274 | Fossil glob patterns are based on the glob pattern feature of POSIX |
| 275 |
| --- www/globs.md | |
| +++ www/globs.md | |
| @@ -18,11 +18,11 @@ | |
| 18 | |
| 19 | [glob]: https://en.wikipedia.org/wiki/Glob_(programming) |
| 20 | [greinc]: https://unix.stackexchange.com/a/57958/138 |
| 21 | [regexp]: https://en.wikipedia.org/wiki/Regular_expression |
| 22 | |
| 23 | [Fossil’s `*-glob` settings](#settings) hold one or more patterns to cause Fossil to |
| 24 | give matching named files special treatment. Glob patterns are also |
| 25 | accepted in options to certain commands and as query parameters to |
| 26 | certain Fossil UI web pages. For consistency, settings such as |
| 27 | `empty-dirs` are parsed as a glob even though they aren’t then *applied* |
| 28 | as a glob since it allows [the same syntax rules](#syntax) to apply. |
| @@ -163,14 +163,15 @@ | |
| 163 | `README` | Matches only a file named `README` in the root of the tree. It does not match a file named `src/README` because it does not include any characters that consume (and match) the `src/` part. |
| 164 | `*/README` | Matches `src/README`. Unlike Unix file globs, it also matches `src/library/README`. However it does not match the file `README` in the root of the tree. |
| 165 | `*README` | Matches `src/README` as well as the file `README` in the root of the tree as well as `foo/bar/README` or any other file named `README` in the tree. However, it also matches `A-DIFFERENT-README` and `src/DO-NOT-README`, or any other file whose name ends with `README`. |
| 166 | `src/README` | Matches `src\README` on Windows because all directory separators are rewritten as `/` in the canonical name before the glob is matched. This makes it much easier to write globs that work on both Unix and Windows. |
| 167 | `*.[ch]` | Matches every C source or header file in the tree at the root or at any depth. Again, this is (deliberately) different from Unix file globs and Windows wild cards. |
| 168 | |
| 169 | |
| 170 | ## Where Globs are Used |
| 171 | |
| 172 | ### <a id="settings"></a>Settings that are Globs |
| 173 | |
| 174 | These settings are all lists of glob patterns: |
| 175 | |
| 176 | :Setting |:Description |
| 177 | -------------------------------------------------------------------------------- |
| @@ -197,12 +198,16 @@ | |
| 198 | commands. This is especially true when one (or more) IDEs are used in |
| 199 | a project because each IDE has its own ideas of how and where to cache |
| 200 | information that speeds up its browsing and building tasks but which |
| 201 | need not be preserved in your project's history. |
| 202 | |
| 203 | Although the `empty-dirs` setting is not a list of glob patterns as |
| 204 | such, it is *parsed* that way for consistency among the settings, |
| 205 | allowing [the list parsing rules above](#syntax) to apply. |
| 206 | |
| 207 | |
| 208 | ### <a id="commands"></a>Commands that Refer to Globs |
| 209 | |
| 210 | Many of the commands that respect the settings containing globs have |
| 211 | options to override some or all of the settings. These options are |
| 212 | usually named to correspond to the setting they override, such as |
| 213 | `--ignore` to override the `ignore-glob` setting. These commands are: |
| @@ -227,29 +232,29 @@ | |
| 232 | The commands [`http`][], [`cgi`][], [`server`][], and [`ui`][] that |
| 233 | implement or support with web servers provide a mechanism to name some |
| 234 | files to serve with static content where a list of glob patterns |
| 235 | specifies what content may be served. |
| 236 | |
| 237 | [`add`]: /help?cmd=add |
| 238 | [`addremove`]: /help?cmd=addremove |
| 239 | [`changes`]: /help?cmd=changes |
| 240 | [`clean`]: /help?cmd=clean |
| 241 | [`commit`]: /help?cmd=commit |
| 242 | [`extras`]: /help?cmd=extras |
| 243 | [`merge`]: /help?cmd=merge |
| 244 | [`settings`]: /help?cmd=settings |
| 245 | [`status`]: /help?cmd=status |
| 246 | [`touch`]: /help?cmd=touch |
| 247 | [`unset`]: /help?cmd=unset |
| 248 | |
| 249 | [`tarball`]: /help?cmd=tarball |
| 250 | [`zip`]: /help?cmd=zip |
| 251 | |
| 252 | [`http`]: /help?cmd=http |
| 253 | [`cgi`]: /help?cmd=cgi |
| 254 | [`server`]: /help?cmd=server |
| 255 | [`ui`]: /help?cmd=ui |
| 256 | |
| 257 | |
| 258 | ### Web Pages that Refer to Globs |
| 259 | |
| 260 | The [`/timeline`][] page supports the query parameter `chng=GLOBLIST` that |
| @@ -263,12 +268,12 @@ | |
| 268 | of a specific checkin. They may be further restricted by query |
| 269 | parameters that specify glob patterns that name files to include or |
| 270 | exclude rather than taking the entire checkin. |
| 271 | |
| 272 | [`/timeline`]: /help?cmd=/timeline |
| 273 | [`/tarball`]: /help?cmd=/tarball |
| 274 | [`/zip`]: /help?cmd=/zip |
| 275 | |
| 276 | |
| 277 | ## Platform Quirks |
| 278 | |
| 279 | Fossil glob patterns are based on the glob pattern feature of POSIX |
| 280 |