Fossil SCM
Clarify that backslashes in the help text of commands/webpages must be escaped for correct processing by mkindex.c.
Commit
5c8f5575657c0e3fec88c6b5bc983599b391e9f7c64e873d5af2ee32652eafcb
Parent
ea688fa67fd0207…
2 files changed
+1
+1
-1
+1
| --- tools/mkindex.c | ||
| +++ tools/mkindex.c | ||
| @@ -59,10 +59,11 @@ | ||
| 59 | 59 | ** New arguments may be added in future releases that set additional |
| 60 | 60 | ** bits in the eCmdFlags field. |
| 61 | 61 | ** |
| 62 | 62 | ** Additional lines of comment after the COMMAND: or WEBPAGE: or SETTING: |
| 63 | 63 | ** become the built-in help text for that command or webpage or setting. |
| 64 | +** Backslashes must be escaped ("\\" in comment yields "\" in the help text.) | |
| 64 | 65 | ** |
| 65 | 66 | ** Multiple COMMAND: entries can be attached to the same command, thus |
| 66 | 67 | ** creating multiple aliases for that command. Similarly, multiple |
| 67 | 68 | ** WEBPAGE: entries can be attached to the same webpage function, to give |
| 68 | 69 | ** that page aliases. |
| 69 | 70 |
| --- tools/mkindex.c | |
| +++ tools/mkindex.c | |
| @@ -59,10 +59,11 @@ | |
| 59 | ** New arguments may be added in future releases that set additional |
| 60 | ** bits in the eCmdFlags field. |
| 61 | ** |
| 62 | ** Additional lines of comment after the COMMAND: or WEBPAGE: or SETTING: |
| 63 | ** become the built-in help text for that command or webpage or setting. |
| 64 | ** |
| 65 | ** Multiple COMMAND: entries can be attached to the same command, thus |
| 66 | ** creating multiple aliases for that command. Similarly, multiple |
| 67 | ** WEBPAGE: entries can be attached to the same webpage function, to give |
| 68 | ** that page aliases. |
| 69 |
| --- tools/mkindex.c | |
| +++ tools/mkindex.c | |
| @@ -59,10 +59,11 @@ | |
| 59 | ** New arguments may be added in future releases that set additional |
| 60 | ** bits in the eCmdFlags field. |
| 61 | ** |
| 62 | ** Additional lines of comment after the COMMAND: or WEBPAGE: or SETTING: |
| 63 | ** become the built-in help text for that command or webpage or setting. |
| 64 | ** Backslashes must be escaped ("\\" in comment yields "\" in the help text.) |
| 65 | ** |
| 66 | ** Multiple COMMAND: entries can be attached to the same command, thus |
| 67 | ** creating multiple aliases for that command. Similarly, multiple |
| 68 | ** WEBPAGE: entries can be attached to the same webpage function, to give |
| 69 | ** that page aliases. |
| 70 |
+1
-1
| --- www/adding_code.wiki | ||
| +++ www/adding_code.wiki | ||
| @@ -118,11 +118,11 @@ | ||
| 118 | 118 | |
| 119 | 119 | <blockquote><verbatim> |
| 120 | 120 | /* |
| 121 | 121 | ** COMMAND: xyzzy |
| 122 | 122 | ** |
| 123 | -** Help text goes here. | |
| 123 | +** Help text goes here. Backslashes must be escaped. | |
| 124 | 124 | */ |
| 125 | 125 | void xyzzy_cmd(void){ |
| 126 | 126 | /* Implement the command here */ |
| 127 | 127 | fossil_print("Hello, World!\n"); |
| 128 | 128 | } |
| 129 | 129 |
| --- www/adding_code.wiki | |
| +++ www/adding_code.wiki | |
| @@ -118,11 +118,11 @@ | |
| 118 | |
| 119 | <blockquote><verbatim> |
| 120 | /* |
| 121 | ** COMMAND: xyzzy |
| 122 | ** |
| 123 | ** Help text goes here. |
| 124 | */ |
| 125 | void xyzzy_cmd(void){ |
| 126 | /* Implement the command here */ |
| 127 | fossil_print("Hello, World!\n"); |
| 128 | } |
| 129 |
| --- www/adding_code.wiki | |
| +++ www/adding_code.wiki | |
| @@ -118,11 +118,11 @@ | |
| 118 | |
| 119 | <blockquote><verbatim> |
| 120 | /* |
| 121 | ** COMMAND: xyzzy |
| 122 | ** |
| 123 | ** Help text goes here. Backslashes must be escaped. |
| 124 | */ |
| 125 | void xyzzy_cmd(void){ |
| 126 | /* Implement the command here */ |
| 127 | fossil_print("Hello, World!\n"); |
| 128 | } |
| 129 |