Fossil SCM

Documentation improvements, especially to the 2.26 change log.

drh 2025-04-26 18:08 trunk
Commit 0f36c889abd3644ba11adb2c0b85dcd53f9443eeb925f0275ea29423e8b41bcb
Parent 4f55b393f0fa168…
2 files changed +14 -10 +20 -5
~ www/changes.wiki ~ www/th1.md
M www/changes.wiki
+14 -10
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,12 +1,12 @@
11
 <title>Change Log</title>
22
33
 <h2 id='v2_26'>Changes for version 2.26 (pending)</h2><ol>
44
 <li>Enhancements to [/help?cmd=diff|fossil diff] and similar:
55
 <ol type="a">
6
- <li> The --from can optionally accept a directory name as its argument,
7
- and uses files under that directory as the baseline for the diff.
6
+ <li> The argument to the --from option can be a directory name, causing
7
+ Fossil to use files under that directory as the baseline for the diff.
88
 <li> For "gdiff", if no [/help?cmd=gdiff-command|gdiff-command setting]
99
 is defined, Fossil tries to do a --tk diff if "tclsh" and "wish"
1010
 are available, or a --by diff if not.
1111
 <li> The "Reload" button is added to --tk diffs, to bring the displayed
1212
 diff up to date with the latest changes on disk.
@@ -84,13 +84,13 @@
8484
 <li> Accept the "Z" (Zulu-time) suffix on date arguments for the
8585
 "ymd" and "yw" query parameters.
8686
 <li> The new "min" query parameter, when added to a from=,to= query,
8787
 collapses long runs of check-ins on the same branch into just
8888
 end-points.
89
- <li> The p= and d= parameters an reference different check-ins, which
90
- case the timeline shows those check-ins that are both ancestors
91
- of p= and descendants of d=.
89
+ <li> The p= and d= parameters can now reference different check-ins,
90
+ in which case the timeline shows those check-ins that are both
91
+ ancestors of p= and descendants of d=.
9292
 <li> The saturation and intensity of user-specified checkin and branch
9393
 background colors are automatically adjusted to keep the colors
9494
 compatible with the current skin, unless the
9595
 [/help?cmd=raw-bgcolor|raw-bgcolor setting] is turned on.
9696
 </ol>
@@ -119,11 +119,11 @@
119119
 COMMAND argument and only shows results for the specified
120120
 subcommand, not the entire command.
121121
 <li> The -u (--usage) option shows only the command-line syntax
122122
 <li> The -o (--options) option shows only the command-line options
123123
 </ol>
124
- <li>Enhancements to the ticket system:
124
+ <li>Enhancements to the [./tickets.wiki|ticket system]:
125125
 <ol type="a">
126126
 <li> Added the ability to attach wiki pages to a ticket for extended
127127
 descriptions.
128128
 <li> Added submenu to the 'View Ticket' page, to use it as
129129
 template for a new ticket.
@@ -136,14 +136,15 @@
136136
 <li>Added the "hash" query parameter to the
137137
 [/help?cmd=/whatis|/whatis webpage].
138138
 <li>Add a "user permissions changes" [/doc/trunk/www/alerts.md|subscription]
139139
 which alerts subscribers when an admin creates a new user or
140140
 when a user's permissions change.
141
- <li>Show project description on repository list.
142
- <li>Make [/help?cmd=/chat|/chat] better-behaved during server outages, reducing
143
- the frequency of reconnection attempts over time and providing feedback
144
- to the user when the connection is down.
141
+ <li>If the FOSSIL_REPOLIST_SHOW environment variable exists and contains
142
+ the substring "description", then the project description for each repository
143
+ is shown on the repository list page. The login-group for each project is
144
+ now only shown if the FOSSIL_REPOLIST_SHOW environment variable exists and
145
+ contains the substring "login-group". ([./cgi.wiki#repolist|More information])
145146
 <li>The [/doc/trunk/www/th1.md|TH1 script language] is enhanced for improved
146147
 security:
147148
 <ol type="a">
148149
 <li> TH1 now makes a distinction between
149150
 [/doc/trunk/www/th1.md#taint|tainted and untainted string values].
@@ -154,10 +155,13 @@
154155
 security problem.
155156
 <li> The "--th" option was removed from the [/help?cmd=pikchr|fossil pikchr]
156157
 command.
157158
 <li> The "enable_htmlify" TH1 command was removed.
158159
 </ol>
160
+ <li>Make [/help?cmd=/chat|/chat] better-behaved during server outages, reducing
161
+ the frequency of reconnection attempts over time and providing feedback
162
+ to the user when the connection is down.
159163
 <li>Many other minor fixes and additions.
160164
 </ol>
161165
162166
 <h2 id='v2_25'>Changes for version 2.25 (2024-11-06)</h2>
163167
164168
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,12 +1,12 @@
1 <title>Change Log</title>
2
3 <h2 id='v2_26'>Changes for version 2.26 (pending)</h2><ol>
4 <li>Enhancements to [/help?cmd=diff|fossil diff] and similar:
5 <ol type="a">
6 <li> The --from can optionally accept a directory name as its argument,
7 and uses files under that directory as the baseline for the diff.
8 <li> For "gdiff", if no [/help?cmd=gdiff-command|gdiff-command setting]
9 is defined, Fossil tries to do a --tk diff if "tclsh" and "wish"
10 are available, or a --by diff if not.
11 <li> The "Reload" button is added to --tk diffs, to bring the displayed
12 diff up to date with the latest changes on disk.
@@ -84,13 +84,13 @@
84 <li> Accept the "Z" (Zulu-time) suffix on date arguments for the
85 "ymd" and "yw" query parameters.
86 <li> The new "min" query parameter, when added to a from=,to= query,
87 collapses long runs of check-ins on the same branch into just
88 end-points.
89 <li> The p= and d= parameters an reference different check-ins, which
90 case the timeline shows those check-ins that are both ancestors
91 of p= and descendants of d=.
92 <li> The saturation and intensity of user-specified checkin and branch
93 background colors are automatically adjusted to keep the colors
94 compatible with the current skin, unless the
95 [/help?cmd=raw-bgcolor|raw-bgcolor setting] is turned on.
96 </ol>
@@ -119,11 +119,11 @@
119 COMMAND argument and only shows results for the specified
120 subcommand, not the entire command.
121 <li> The -u (--usage) option shows only the command-line syntax
122 <li> The -o (--options) option shows only the command-line options
123 </ol>
124 <li>Enhancements to the ticket system:
125 <ol type="a">
126 <li> Added the ability to attach wiki pages to a ticket for extended
127 descriptions.
128 <li> Added submenu to the 'View Ticket' page, to use it as
129 template for a new ticket.
@@ -136,14 +136,15 @@
136 <li>Added the "hash" query parameter to the
137 [/help?cmd=/whatis|/whatis webpage].
138 <li>Add a "user permissions changes" [/doc/trunk/www/alerts.md|subscription]
139 which alerts subscribers when an admin creates a new user or
140 when a user's permissions change.
141 <li>Show project description on repository list.
142 <li>Make [/help?cmd=/chat|/chat] better-behaved during server outages, reducing
143 the frequency of reconnection attempts over time and providing feedback
144 to the user when the connection is down.
 
145 <li>The [/doc/trunk/www/th1.md|TH1 script language] is enhanced for improved
146 security:
147 <ol type="a">
148 <li> TH1 now makes a distinction between
149 [/doc/trunk/www/th1.md#taint|tainted and untainted string values].
@@ -154,10 +155,13 @@
154 security problem.
155 <li> The "--th" option was removed from the [/help?cmd=pikchr|fossil pikchr]
156 command.
157 <li> The "enable_htmlify" TH1 command was removed.
158 </ol>
 
 
 
159 <li>Many other minor fixes and additions.
160 </ol>
161
162 <h2 id='v2_25'>Changes for version 2.25 (2024-11-06)</h2>
163
164
--- www/changes.wiki
+++ www/changes.wiki
@@ -1,12 +1,12 @@
1 <title>Change Log</title>
2
3 <h2 id='v2_26'>Changes for version 2.26 (pending)</h2><ol>
4 <li>Enhancements to [/help?cmd=diff|fossil diff] and similar:
5 <ol type="a">
6 <li> The argument to the --from option can be a directory name, causing
7 Fossil to use files under that directory as the baseline for the diff.
8 <li> For "gdiff", if no [/help?cmd=gdiff-command|gdiff-command setting]
9 is defined, Fossil tries to do a --tk diff if "tclsh" and "wish"
10 are available, or a --by diff if not.
11 <li> The "Reload" button is added to --tk diffs, to bring the displayed
12 diff up to date with the latest changes on disk.
@@ -84,13 +84,13 @@
84 <li> Accept the "Z" (Zulu-time) suffix on date arguments for the
85 "ymd" and "yw" query parameters.
86 <li> The new "min" query parameter, when added to a from=,to= query,
87 collapses long runs of check-ins on the same branch into just
88 end-points.
89 <li> The p= and d= parameters can now reference different check-ins,
90 in which case the timeline shows those check-ins that are both
91 ancestors of p= and descendants of d=.
92 <li> The saturation and intensity of user-specified checkin and branch
93 background colors are automatically adjusted to keep the colors
94 compatible with the current skin, unless the
95 [/help?cmd=raw-bgcolor|raw-bgcolor setting] is turned on.
96 </ol>
@@ -119,11 +119,11 @@
119 COMMAND argument and only shows results for the specified
120 subcommand, not the entire command.
121 <li> The -u (--usage) option shows only the command-line syntax
122 <li> The -o (--options) option shows only the command-line options
123 </ol>
124 <li>Enhancements to the [./tickets.wiki|ticket system]:
125 <ol type="a">
126 <li> Added the ability to attach wiki pages to a ticket for extended
127 descriptions.
128 <li> Added submenu to the 'View Ticket' page, to use it as
129 template for a new ticket.
@@ -136,14 +136,15 @@
136 <li>Added the "hash" query parameter to the
137 [/help?cmd=/whatis|/whatis webpage].
138 <li>Add a "user permissions changes" [/doc/trunk/www/alerts.md|subscription]
139 which alerts subscribers when an admin creates a new user or
140 when a user's permissions change.
141 <li>If the FOSSIL_REPOLIST_SHOW environment variable exists and contains
142 the substring "description", then the project description for each repository
143 is shown on the repository list page. The login-group for each project is
144 now only shown if the FOSSIL_REPOLIST_SHOW environment variable exists and
145 contains the substring "login-group". ([./cgi.wiki#repolist|More information])
146 <li>The [/doc/trunk/www/th1.md|TH1 script language] is enhanced for improved
147 security:
148 <ol type="a">
149 <li> TH1 now makes a distinction between
150 [/doc/trunk/www/th1.md#taint|tainted and untainted string values].
@@ -154,10 +155,13 @@
155 security problem.
156 <li> The "--th" option was removed from the [/help?cmd=pikchr|fossil pikchr]
157 command.
158 <li> The "enable_htmlify" TH1 command was removed.
159 </ol>
160 <li>Make [/help?cmd=/chat|/chat] better-behaved during server outages, reducing
161 the frequency of reconnection attempts over time and providing feedback
162 to the user when the connection is down.
163 <li>Many other minor fixes and additions.
164 </ol>
165
166 <h2 id='v2_25'>Changes for version 2.25 (2024-11-06)</h2>
167
168
M www/th1.md
+20 -5
--- www/th1.md
+++ www/th1.md
@@ -12,29 +12,43 @@
1212
 time all of the test cases for SQLite were written in Tcl and Tcl could not
1313
 be easily compiled on the SymbianOS. So TH1 was developed as a cut-down
1414
 version of Tcl that would facilitate running the SQLite test scripts on
1515
 SymbianOS.
1616
17
-Fossil was first being designed at about the same time that TH1 was
18
-being developed for testing SQLite on SymbianOS.
17
+Fossil was first being designed at about the same time.
1918
 Early prototypes of Fossil were written in pure Tcl. But as the development
2019
 shifted toward the use of C-code, the need arose to have a Tcl-like
2120
 scripting language to help with code generation. TH1 was small and
2221
 light-weight and used minimal resources and seemed ideally suited for the
2322
 task.
2423
25
-The name "TH1" stands "Test Harness 1", since that was its original purpose.
24
+The name "TH1" stands for "Test Harness 1",
25
+since its original purpose was to serve as testing harness
26
+for SQLite.
2627
27
-Overview
---------
28
+Where TH1 Is Used In Fossil
29
+---------------------------
30
+
31
+ * In the header and footer for [skins](./customskin.md)
32
+ text within `<th1>...</th1>` is run as a TH1 script.
33
+ ([example](/builtin/skins/default/header.txt))
34
+
35
+ * This display of [tickets](./bugtheory.wiki) is controlled by TH1
36
+ scripts, so that the ticket format can be customized for each
37
+ project. Administrators can visit the <b>/tktsetup</b> page in
38
+ their repositories to view and customize these scripts.
39
+ ([example usage](./custom_ticket.wiki))
40
+
41
+Overview Of The Tcl/TH1 Language
42
+--------------------------------
2843
2944
 TH1 is a string-processing language. All values are strings. Any numerical
3045
 operations are accomplished by converting from string to numeric, performing
3146
 the computation, then converting the result back into a string. (This might
3247
 seem inefficient, but it is faster than people imagine, and numeric
3348
 computations do not come up very often for the kinds of work that TH1 does,
34
-so it has never been a factor.)
49
+so it has never been an issue.)
3550
3651
 A TH1 script consists of a sequence of commands.
3752
 Each command is terminated by the first *unescaped* newline or ";" character.
3853
 The text of the command (excluding the newline or semicolon terminator)
3954
 is broken into space-separated tokens. The first token is the command
4055
--- www/th1.md
+++ www/th1.md
@@ -12,29 +12,43 @@
12 time all of the test cases for SQLite were written in Tcl and Tcl could not
13 be easily compiled on the SymbianOS. So TH1 was developed as a cut-down
14 version of Tcl that would facilitate running the SQLite test scripts on
15 SymbianOS.
16
17 Fossil was first being designed at about the same time that TH1 was
18 being developed for testing SQLite on SymbianOS.
19 Early prototypes of Fossil were written in pure Tcl. But as the development
20 shifted toward the use of C-code, the need arose to have a Tcl-like
21 scripting language to help with code generation. TH1 was small and
22 light-weight and used minimal resources and seemed ideally suited for the
23 task.
24
25 The name "TH1" stands "Test Harness 1", since that was its original purpose.
 
 
26
27 Overview
---------
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
28
29 TH1 is a string-processing language. All values are strings. Any numerical
30 operations are accomplished by converting from string to numeric, performing
31 the computation, then converting the result back into a string. (This might
32 seem inefficient, but it is faster than people imagine, and numeric
33 computations do not come up very often for the kinds of work that TH1 does,
34 so it has never been a factor.)
35
36 A TH1 script consists of a sequence of commands.
37 Each command is terminated by the first *unescaped* newline or ";" character.
38 The text of the command (excluding the newline or semicolon terminator)
39 is broken into space-separated tokens. The first token is the command
40
--- www/th1.md
+++ www/th1.md
@@ -12,29 +12,43 @@
12 time all of the test cases for SQLite were written in Tcl and Tcl could not
13 be easily compiled on the SymbianOS. So TH1 was developed as a cut-down
14 version of Tcl that would facilitate running the SQLite test scripts on
15 SymbianOS.
16
17 Fossil was first being designed at about the same time.
 
18 Early prototypes of Fossil were written in pure Tcl. But as the development
19 shifted toward the use of C-code, the need arose to have a Tcl-like
20 scripting language to help with code generation. TH1 was small and
21 light-weight and used minimal resources and seemed ideally suited for the
22 task.
23
24 The name "TH1" stands for "Test Harness 1",
25 since its original purpose was to serve as testing harness
26 for SQLite.
27
 
---------
28 Where TH1 Is Used In Fossil
29 ---------------------------
30
31 * In the header and footer for [skins](./customskin.md)
32 text within `<th1>...</th1>` is run as a TH1 script.
33 ([example](/builtin/skins/default/header.txt))
34
35 * This display of [tickets](./bugtheory.wiki) is controlled by TH1
36 scripts, so that the ticket format can be customized for each
37 project. Administrators can visit the <b>/tktsetup</b> page in
38 their repositories to view and customize these scripts.
39 ([example usage](./custom_ticket.wiki))
40
41 Overview Of The Tcl/TH1 Language
42 --------------------------------
43
44 TH1 is a string-processing language. All values are strings. Any numerical
45 operations are accomplished by converting from string to numeric, performing
46 the computation, then converting the result back into a string. (This might
47 seem inefficient, but it is faster than people imagine, and numeric
48 computations do not come up very often for the kinds of work that TH1 does,
49 so it has never been an issue.)
50
51 A TH1 script consists of a sequence of commands.
52 Each command is terminated by the first *unescaped* newline or ";" character.
53 The text of the command (excluding the newline or semicolon terminator)
54 is broken into space-separated tokens. The first token is the command
55

Keyboard Shortcuts

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