Fossil SCM

More editorial work.

rberteig 2017-04-18 19:50 glob-docs
Commit 1adc47e0ef0c3c46fac88eb824204b362cb9135b14e5a710c814293f3b7cb261
Parent 1239b6c47041082…
2 files changed +72 -40 +1 -1
~ www/globs.md ~ www/mkindex.tcl
M www/globs.md
+72 -40
--- www/globs.md
+++ www/globs.md
@@ -1,28 +1,29 @@
1
-File Name GLOB Patterns
2
-=======================
1
+# File Name Glob Patterns
2
+
33
44
 A [glob pattern][glob] is a text expression that matches one or more
55
 file names using wild cards familiar to most users of a command line.
66
 For example, `*` is a glob that matches any name at all and
7
-`Readme.txt` is a glob that matches exactly one file. Note that
8
-although they are related, glob patterns are not the same thing as a
9
-[regular expression or regexp][regexp].
7
+`Readme.txt` is a glob that matches exactly one file.
8
+
9
+Note that although both are notations for describing patterns in text,
10
+glob patterns are not the same thing as a [regular expression or
11
+regexp][regexp].
1012
1113
 [glob]: https://en.wikipedia.org/wiki/Glob_(programming) (Wikipedia)
1214
 [regexp]: https://en.wikipedia.org/wiki/Regular_expression
1315
1416
1517
 A number of fossil setting values hold one or more file glob patterns
16
-that will match files either on the disk or in the active checkout.
17
-Glob patterns are also accepted in options to certain commands as well
18
-as query parameters to certain pages.
18
+that will identify files needing special treatment. Glob patterns are
19
+also accepted in options to certain commands as well as query
20
+parameters to certain pages.
1921
2022
 In many cases more than one glob may be specified in a setting,
2123
 option, or query parameter by listing multiple globs separated by a
22
-comma or white space. If a glob must contain commas or spaces,
23
-surround it with single or double quotation marks.
24
+comma or white space.
2425
2526
 Of course, many fossil commands also accept lists of files to act on,
2627
 and those also may be specified with globs. Although those glob
2728
 patterns are similar to what is described here, they are not defined
2829
 by fossil, but rather by the conventions of the operating system in
@@ -57,15 +58,19 @@
5758
 Special character sequences have some additional features:
5859
5960
 * A range of characters may be specified with `-`, so `[a-d]` matches
6061
 exactly the same characters as `[abcd]`. Ranges reflect Unicode
6162
 code points without any locale-specific collation sequence.
63
+
6264
 * Include `-` in a list by placing it last, just before the `]`.
65
+
6366
 * Include `]` in a list by making the first character after the `[` or
6467
 `[^`. At any other place, `]` ends the list.
68
+
6569
 * Include `^` in a list by placing anywhere except first after the
6670
 `[`.
71
+
6772
 * Some examples of character lists:
6873
 `[a-d]` Matches any one of `a`, `b`, `c`, or `d` but not `ä`;
6974
 `[^a-d]` Matches exactly one character other than `a`, `b`, `c`,
7075
 or `d`;
7176
 `[0-9a-fA-F]` Matches exactly one hexadecimal digit;
@@ -72,17 +77,20 @@
7277
 `[a-]` Matches either `a` or `-`;
7378
 `[][]` Matches either `]` or `[`;
7479
 `[^]]` Matches exactly one character other than `]`;
7580
 `[]^]` Matches either `]` or `^`; and
7681
 `[^-]` Matches exactly one character other than `-`.
77
- * Beware that ranges in lists may include more than you expect:
82
+
83
+ Beware that ranges in lists may include more than you expect:
7884
 `[A-z]` Matches `A` and `Z`, but also matches `a` and some less
7985
 obvious characters such as `[`, `\`, and `]` with code point
8086
 values between `Z` and `a`.
81
- * Beware that a range must be specified from low value to high
87
+
88
+ Beware that a range must be specified from low value to high
8289
 value: `[z-a]` does not match any character at all, preventing the
8390
 entire glob from matching.
91
+
8492
 * Note that unlike typical Unix shell globs, wildcards (`*`, `?`,
8593
 and character lists) are allowed to match `/` directory
8694
 separators as well as the initial `.` in the name of a hidden
8795
 file or directory.
8896
@@ -181,42 +189,66 @@
181189
 Many of the commands that respect the settings containing globs have
182190
 options to override some or all of the settings. These options are
183191
 usually named to correspond to the setting they override, such as
184192
 `--ignore` to override the `ignore-glob` setting. These commands are:
185193
186
- * `add`
187
- * `addremove`
188
- * `changes`
189
- * `clean`
190
- * `extras`
191
- * `merge`
192
- * `settings`
193
- * `status`
194
- * `unset`
195
-
196
-The commands `tarball` and `zip` produce compressed archives of a
194
+ * [`add`][]
195
+ * [`addremove`][]
196
+ * [`changes`][]
197
+ * [`clean`][]
198
+ * [`extras`][]
199
+ * [`merge`][]
200
+ * [`settings`][]
201
+ * [`status`][]
202
+ * [`unset`][]
203
+
204
+The commands [`tarball`][] and [`zip`][] produce compressed archives of a
197205
 specific checkin. They may be further restricted by options that
198206
 specify glob patterns that name files to include or exclude rather
199207
 than archiving the entire checkin.
200208
201
-The commands `http`, `cgi`, `server`, and `ui` that implement or
202
-support with web servers provide a mechanism to name some files to
203
-serve with static content where a list of GLOBs specifies what content
204
-may be served.
205
-
206
-
207
-### Web pages that refer to GLOBs
208
-
209
-The `/timeline` page supports a query parameter that names a GLOB of
210
-files to focus the timeline on. It also can use `GLOB`, `LIKE`, or
211
-`REGEXP` matching on tag names, where each is implemented by the
212
-corresponding operator in [SQLite][].
213
-
214
-The pages `/tarball` and `/zip` generate compressed archives of a
215
-specific checkin. They may be further restricted by query parameters
216
-that specify GLOBs that name files to include or exclude rather than
217
-taking the entire checkin.
209
+The commands [`http`][], [`cgi`][], [`server`][], and [`ui`][] that
210
+implement or support with web servers provide a mechanism to name some
211
+files to serve with static content where a list of glob patterns
212
+specifies what content may be served.
213
+
214
+[`add`]: /help?cmd=add
215
+[`addremove`]: /help?cmd=addremove
216
+[`changes`]: /help?cmd=changes
217
+[`clean`]: /help?cmd=clean
218
+[`extras`]: /help?cmd=extras
219
+[`merge`]: /help?cmd=merge
220
+[`settings`]: /help?cmd=settings
221
+[`status`]: /help?cmd=status
222
+[`unset`]: /help?cmd=unset
223
+
224
+[`tarball`]: /help?cmd=tarball
225
+[`zip`]: /help?cmd=zip
226
+
227
+[`http`]: /help?cmd=http
228
+[`cgi`]: /help?cmd=cgi
229
+[`server`]: /help?cmd=server
230
+[`ui`]: /help?cmd=ui
231
+
232
+
233
+### Web Pages that Refer to Globs
234
+
235
+The [`/timeline`][] page supports the query parameter `chng=GLOBLIST` that
236
+names a list of glob patterns defining which files to focus the
237
+timeline on. It also has the query parameters `t=TAG` and `r=TAG` that
238
+names a tag to focus on, which can be configured with `ms=STYLE` to
239
+use a glob pattern to match tag names instead of the default exact
240
+match or a couple of other comparison styles.
241
+
242
+The pages [`/tarball`][] and [`/zip`][] generate compressed archives
243
+of a specific checkin. They may be further restricted by query
244
+parameters that specify GLOBs that name files to include or exclude
245
+rather than taking the entire checkin.
246
+
247
+[`/timeline`]: /help?cmd=/timeline
248
+[`/tarball`]: /help?cmd=/tarball
249
+[`/zip`]: /help?cmd=/zip
218250
219251
220252
 ## Platform quirks
221253
222254
 The versioned settings files have no platform-specific quirks. Any
223255
--- www/globs.md
+++ www/globs.md
@@ -1,28 +1,29 @@
1 File Name GLOB Patterns
2 =======================
3
4 A [glob pattern][glob] is a text expression that matches one or more
5 file names using wild cards familiar to most users of a command line.
6 For example, `*` is a glob that matches any name at all and
7 `Readme.txt` is a glob that matches exactly one file. Note that
8 although they are related, glob patterns are not the same thing as a
9 [regular expression or regexp][regexp].
 
 
10
11 [glob]: https://en.wikipedia.org/wiki/Glob_(programming) (Wikipedia)
12 [regexp]: https://en.wikipedia.org/wiki/Regular_expression
13
14
15 A number of fossil setting values hold one or more file glob patterns
16 that will match files either on the disk or in the active checkout.
17 Glob patterns are also accepted in options to certain commands as well
18 as query parameters to certain pages.
19
20 In many cases more than one glob may be specified in a setting,
21 option, or query parameter by listing multiple globs separated by a
22 comma or white space. If a glob must contain commas or spaces,
23 surround it with single or double quotation marks.
24
25 Of course, many fossil commands also accept lists of files to act on,
26 and those also may be specified with globs. Although those glob
27 patterns are similar to what is described here, they are not defined
28 by fossil, but rather by the conventions of the operating system in
@@ -57,15 +58,19 @@
57 Special character sequences have some additional features:
58
59 * A range of characters may be specified with `-`, so `[a-d]` matches
60 exactly the same characters as `[abcd]`. Ranges reflect Unicode
61 code points without any locale-specific collation sequence.
 
62 * Include `-` in a list by placing it last, just before the `]`.
 
63 * Include `]` in a list by making the first character after the `[` or
64 `[^`. At any other place, `]` ends the list.
 
65 * Include `^` in a list by placing anywhere except first after the
66 `[`.
 
67 * Some examples of character lists:
68 `[a-d]` Matches any one of `a`, `b`, `c`, or `d` but not `ä`;
69 `[^a-d]` Matches exactly one character other than `a`, `b`, `c`,
70 or `d`;
71 `[0-9a-fA-F]` Matches exactly one hexadecimal digit;
@@ -72,17 +77,20 @@
72 `[a-]` Matches either `a` or `-`;
73 `[][]` Matches either `]` or `[`;
74 `[^]]` Matches exactly one character other than `]`;
75 `[]^]` Matches either `]` or `^`; and
76 `[^-]` Matches exactly one character other than `-`.
77 * Beware that ranges in lists may include more than you expect:
 
78 `[A-z]` Matches `A` and `Z`, but also matches `a` and some less
79 obvious characters such as `[`, `\`, and `]` with code point
80 values between `Z` and `a`.
81 * Beware that a range must be specified from low value to high
 
82 value: `[z-a]` does not match any character at all, preventing the
83 entire glob from matching.
 
84 * Note that unlike typical Unix shell globs, wildcards (`*`, `?`,
85 and character lists) are allowed to match `/` directory
86 separators as well as the initial `.` in the name of a hidden
87 file or directory.
88
@@ -181,42 +189,66 @@
181 Many of the commands that respect the settings containing globs have
182 options to override some or all of the settings. These options are
183 usually named to correspond to the setting they override, such as
184 `--ignore` to override the `ignore-glob` setting. These commands are:
185
186 * `add`
187 * `addremove`
188 * `changes`
189 * `clean`
190 * `extras`
191 * `merge`
192 * `settings`
193 * `status`
194 * `unset`
195
196 The commands `tarball` and `zip` produce compressed archives of a
197 specific checkin. They may be further restricted by options that
198 specify glob patterns that name files to include or exclude rather
199 than archiving the entire checkin.
200
201 The commands `http`, `cgi`, `server`, and `ui` that implement or
202 support with web servers provide a mechanism to name some files to
203 serve with static content where a list of GLOBs specifies what content
204 may be served.
205
206
207 ### Web pages that refer to GLOBs
208
209 The `/timeline` page supports a query parameter that names a GLOB of
210 files to focus the timeline on. It also can use `GLOB`, `LIKE`, or
211 `REGEXP` matching on tag names, where each is implemented by the
212 corresponding operator in [SQLite][].
213
214 The pages `/tarball` and `/zip` generate compressed archives of a
215 specific checkin. They may be further restricted by query parameters
216 that specify GLOBs that name files to include or exclude rather than
217 taking the entire checkin.
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
218
219
220 ## Platform quirks
221
222 The versioned settings files have no platform-specific quirks. Any
223
--- www/globs.md
+++ www/globs.md
@@ -1,28 +1,29 @@
1 # File Name Glob Patterns
2
3
4 A [glob pattern][glob] is a text expression that matches one or more
5 file names using wild cards familiar to most users of a command line.
6 For example, `*` is a glob that matches any name at all and
7 `Readme.txt` is a glob that matches exactly one file.
8
9 Note that although both are notations for describing patterns in text,
10 glob patterns are not the same thing as a [regular expression or
11 regexp][regexp].
12
13 [glob]: https://en.wikipedia.org/wiki/Glob_(programming) (Wikipedia)
14 [regexp]: https://en.wikipedia.org/wiki/Regular_expression
15
16
17 A number of fossil setting values hold one or more file glob patterns
18 that will identify files needing special treatment. Glob patterns are
19 also accepted in options to certain commands as well as query
20 parameters to certain pages.
21
22 In many cases more than one glob may be specified in a setting,
23 option, or query parameter by listing multiple globs separated by a
24 comma or white space.
 
25
26 Of course, many fossil commands also accept lists of files to act on,
27 and those also may be specified with globs. Although those glob
28 patterns are similar to what is described here, they are not defined
29 by fossil, but rather by the conventions of the operating system in
@@ -57,15 +58,19 @@
58 Special character sequences have some additional features:
59
60 * A range of characters may be specified with `-`, so `[a-d]` matches
61 exactly the same characters as `[abcd]`. Ranges reflect Unicode
62 code points without any locale-specific collation sequence.
63
64 * Include `-` in a list by placing it last, just before the `]`.
65
66 * Include `]` in a list by making the first character after the `[` or
67 `[^`. At any other place, `]` ends the list.
68
69 * Include `^` in a list by placing anywhere except first after the
70 `[`.
71
72 * Some examples of character lists:
73 `[a-d]` Matches any one of `a`, `b`, `c`, or `d` but not `ä`;
74 `[^a-d]` Matches exactly one character other than `a`, `b`, `c`,
75 or `d`;
76 `[0-9a-fA-F]` Matches exactly one hexadecimal digit;
@@ -72,17 +77,20 @@
77 `[a-]` Matches either `a` or `-`;
78 `[][]` Matches either `]` or `[`;
79 `[^]]` Matches exactly one character other than `]`;
80 `[]^]` Matches either `]` or `^`; and
81 `[^-]` Matches exactly one character other than `-`.
82
83 Beware that ranges in lists may include more than you expect:
84 `[A-z]` Matches `A` and `Z`, but also matches `a` and some less
85 obvious characters such as `[`, `\`, and `]` with code point
86 values between `Z` and `a`.
87
88 Beware that a range must be specified from low value to high
89 value: `[z-a]` does not match any character at all, preventing the
90 entire glob from matching.
91
92 * Note that unlike typical Unix shell globs, wildcards (`*`, `?`,
93 and character lists) are allowed to match `/` directory
94 separators as well as the initial `.` in the name of a hidden
95 file or directory.
96
@@ -181,42 +189,66 @@
189 Many of the commands that respect the settings containing globs have
190 options to override some or all of the settings. These options are
191 usually named to correspond to the setting they override, such as
192 `--ignore` to override the `ignore-glob` setting. These commands are:
193
194 * [`add`][]
195 * [`addremove`][]
196 * [`changes`][]
197 * [`clean`][]
198 * [`extras`][]
199 * [`merge`][]
200 * [`settings`][]
201 * [`status`][]
202 * [`unset`][]
203
204 The commands [`tarball`][] and [`zip`][] produce compressed archives of a
205 specific checkin. They may be further restricted by options that
206 specify glob patterns that name files to include or exclude rather
207 than archiving the entire checkin.
208
209 The commands [`http`][], [`cgi`][], [`server`][], and [`ui`][] that
210 implement or support with web servers provide a mechanism to name some
211 files to serve with static content where a list of glob patterns
212 specifies what content may be served.
213
214 [`add`]: /help?cmd=add
215 [`addremove`]: /help?cmd=addremove
216 [`changes`]: /help?cmd=changes
217 [`clean`]: /help?cmd=clean
218 [`extras`]: /help?cmd=extras
219 [`merge`]: /help?cmd=merge
220 [`settings`]: /help?cmd=settings
221 [`status`]: /help?cmd=status
222 [`unset`]: /help?cmd=unset
223
224 [`tarball`]: /help?cmd=tarball
225 [`zip`]: /help?cmd=zip
226
227 [`http`]: /help?cmd=http
228 [`cgi`]: /help?cmd=cgi
229 [`server`]: /help?cmd=server
230 [`ui`]: /help?cmd=ui
231
232
233 ### Web Pages that Refer to Globs
234
235 The [`/timeline`][] page supports the query parameter `chng=GLOBLIST` that
236 names a list of glob patterns defining which files to focus the
237 timeline on. It also has the query parameters `t=TAG` and `r=TAG` that
238 names a tag to focus on, which can be configured with `ms=STYLE` to
239 use a glob pattern to match tag names instead of the default exact
240 match or a couple of other comparison styles.
241
242 The pages [`/tarball`][] and [`/zip`][] generate compressed archives
243 of a specific checkin. They may be further restricted by query
244 parameters that specify GLOBs that name files to include or exclude
245 rather than taking the entire checkin.
246
247 [`/timeline`]: /help?cmd=/timeline
248 [`/tarball`]: /help?cmd=/tarball
249 [`/zip`]: /help?cmd=/zip
250
251
252 ## Platform quirks
253
254 The versioned settings files have no platform-specific quirks. Any
255
M www/mkindex.tcl
+1 -1
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -36,11 +36,11 @@
3636
 fileformat.wiki {Fossil File Format}
3737
 fiveminutes.wiki {Up and Running in 5 Minutes as a Single User}
3838
 foss-cklist.wiki {Checklist For Successful Open-Source Projects}
3939
 fossil-from-msvc.wiki {Integrating Fossil in the Microsoft Express 2010 IDE}
4040
 fossil-v-git.wiki {Fossil Versus Git}
41
- globs.md {Filename GLOB Patterns}
41
+ globs.md {File Name Glob Patterns}
4242
 hacker-howto.wiki {Hacker How-To}
4343
 hashpolicy.wiki {Hash Policy: Choosing Between SHA1 and SHA3-256}
4444
 /help {Lists of Commands and Webpages}
4545
 hints.wiki {Fossil Tips And Usage Hints}
4646
 index.wiki {Home Page}
4747
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -36,11 +36,11 @@
36 fileformat.wiki {Fossil File Format}
37 fiveminutes.wiki {Up and Running in 5 Minutes as a Single User}
38 foss-cklist.wiki {Checklist For Successful Open-Source Projects}
39 fossil-from-msvc.wiki {Integrating Fossil in the Microsoft Express 2010 IDE}
40 fossil-v-git.wiki {Fossil Versus Git}
41 globs.md {Filename GLOB Patterns}
42 hacker-howto.wiki {Hacker How-To}
43 hashpolicy.wiki {Hash Policy: Choosing Between SHA1 and SHA3-256}
44 /help {Lists of Commands and Webpages}
45 hints.wiki {Fossil Tips And Usage Hints}
46 index.wiki {Home Page}
47
--- www/mkindex.tcl
+++ www/mkindex.tcl
@@ -36,11 +36,11 @@
36 fileformat.wiki {Fossil File Format}
37 fiveminutes.wiki {Up and Running in 5 Minutes as a Single User}
38 foss-cklist.wiki {Checklist For Successful Open-Source Projects}
39 fossil-from-msvc.wiki {Integrating Fossil in the Microsoft Express 2010 IDE}
40 fossil-v-git.wiki {Fossil Versus Git}
41 globs.md {File Name Glob Patterns}
42 hacker-howto.wiki {Hacker How-To}
43 hashpolicy.wiki {Hash Policy: Choosing Between SHA1 and SHA3-256}
44 /help {Lists of Commands and Webpages}
45 hints.wiki {Fossil Tips And Usage Hints}
46 index.wiki {Home Page}
47

Keyboard Shortcuts

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