Fossil SCM
Document the new --ckout-alias option.
Commit
433b9df3e22649794a4f91453c32be151c45f282898115b592cc53220dc5898f
Parent
dc1121f6a755398…
2 files changed
+7
+9
+7
| --- www/changes.wiki | ||
| +++ www/changes.wiki | ||
| @@ -10,10 +10,17 @@ | ||
| 10 | 10 | "sitemap-*" settings. The older settings are no longer used. |
| 11 | 11 | <b>This change might require minor server configuration |
| 12 | 12 | adjustments on servers that use /sitemap extensions.</b> |
| 13 | 13 | The /Admin/Configuration page provides the ability to edit |
| 14 | 14 | the new "sitemap-extra" setting. |
| 15 | + * Added the "--ckout-alias NAME" option to | |
| 16 | + [/help?cmd=ui|fossil ui], [/help?cmd=server|fossil server], and | |
| 17 | + [/help?cmd=http|fossil http]. This option causes Fossil to | |
| 18 | + understand URIs of the form "/doc/NAME/..." as if they were | |
| 19 | + "[/help?cmd=/doc|/doc/ckout/...]", to facilitate testing of | |
| 20 | + [./embeddeddoc.wiki|embedded documentation] changes prior to | |
| 21 | + check-in. | |
| 15 | 22 | * The "pikchr-background" settings is now available in |
| 16 | 23 | "detail.txt" skin files, for better control of Pikchr |
| 17 | 24 | colors in inverted color schemes. |
| 18 | 25 | * The hamburger menu is now available on the built-in |
| 19 | 26 | "[/skn_ardoise/doc/trunk/www/changes.wiki#v2_15|ardoise]" and |
| 20 | 27 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -10,10 +10,17 @@ | |
| 10 | "sitemap-*" settings. The older settings are no longer used. |
| 11 | <b>This change might require minor server configuration |
| 12 | adjustments on servers that use /sitemap extensions.</b> |
| 13 | The /Admin/Configuration page provides the ability to edit |
| 14 | the new "sitemap-extra" setting. |
| 15 | * The "pikchr-background" settings is now available in |
| 16 | "detail.txt" skin files, for better control of Pikchr |
| 17 | colors in inverted color schemes. |
| 18 | * The hamburger menu is now available on the built-in |
| 19 | "[/skn_ardoise/doc/trunk/www/changes.wiki#v2_15|ardoise]" and |
| 20 |
| --- www/changes.wiki | |
| +++ www/changes.wiki | |
| @@ -10,10 +10,17 @@ | |
| 10 | "sitemap-*" settings. The older settings are no longer used. |
| 11 | <b>This change might require minor server configuration |
| 12 | adjustments on servers that use /sitemap extensions.</b> |
| 13 | The /Admin/Configuration page provides the ability to edit |
| 14 | the new "sitemap-extra" setting. |
| 15 | * Added the "--ckout-alias NAME" option to |
| 16 | [/help?cmd=ui|fossil ui], [/help?cmd=server|fossil server], and |
| 17 | [/help?cmd=http|fossil http]. This option causes Fossil to |
| 18 | understand URIs of the form "/doc/NAME/..." as if they were |
| 19 | "[/help?cmd=/doc|/doc/ckout/...]", to facilitate testing of |
| 20 | [./embeddeddoc.wiki|embedded documentation] changes prior to |
| 21 | check-in. |
| 22 | * The "pikchr-background" settings is now available in |
| 23 | "detail.txt" skin files, for better control of Pikchr |
| 24 | colors in inverted color schemes. |
| 25 | * The hamburger menu is now available on the built-in |
| 26 | "[/skn_ardoise/doc/trunk/www/changes.wiki#v2_15|ardoise]" and |
| 27 |
+9
| --- www/embeddeddoc.wiki | ||
| +++ www/embeddeddoc.wiki | ||
| @@ -66,10 +66,19 @@ | ||
| 66 | 66 | languages like HTML, there is still a lot of variation among rendering |
| 67 | 67 | engines for Fossil's markup languages, Markdown and Fossil Wiki. Your |
| 68 | 68 | changes may look fine in your whizzy GUI Markdown editor, but what |
| 69 | 69 | actually matters is how <i>Fossil</i> will interpret your Markdown text. |
| 70 | 70 | Therefore, you should always preview your edits before committing them. |
| 71 | + | |
| 72 | +To help make "ckout" easier to use, the "[/help?cmd=ui|fossil ui]" | |
| 73 | +command has the "--ckout-alias NAME" option that makes NAME an | |
| 74 | +alias for "ckout". If you are editing a collection of documents | |
| 75 | +that have hardcoded links to one another in the form of | |
| 76 | +"/doc/trunk/...", for example, you can test your changes by | |
| 77 | +running "fossil ui --ckout-alias trunk" and all of the links will | |
| 78 | +point to your uncommitted edits rather than to the latest trunk | |
| 79 | +check-in. | |
| 71 | 80 | |
| 72 | 81 | Finally, the <i><filename></i> element of the URL is the |
| 73 | 82 | pathname of the documentation file relative to the root of the source |
| 74 | 83 | tree. |
| 75 | 84 | |
| 76 | 85 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -66,10 +66,19 @@ | |
| 66 | languages like HTML, there is still a lot of variation among rendering |
| 67 | engines for Fossil's markup languages, Markdown and Fossil Wiki. Your |
| 68 | changes may look fine in your whizzy GUI Markdown editor, but what |
| 69 | actually matters is how <i>Fossil</i> will interpret your Markdown text. |
| 70 | Therefore, you should always preview your edits before committing them. |
| 71 | |
| 72 | Finally, the <i><filename></i> element of the URL is the |
| 73 | pathname of the documentation file relative to the root of the source |
| 74 | tree. |
| 75 | |
| 76 |
| --- www/embeddeddoc.wiki | |
| +++ www/embeddeddoc.wiki | |
| @@ -66,10 +66,19 @@ | |
| 66 | languages like HTML, there is still a lot of variation among rendering |
| 67 | engines for Fossil's markup languages, Markdown and Fossil Wiki. Your |
| 68 | changes may look fine in your whizzy GUI Markdown editor, but what |
| 69 | actually matters is how <i>Fossil</i> will interpret your Markdown text. |
| 70 | Therefore, you should always preview your edits before committing them. |
| 71 | |
| 72 | To help make "ckout" easier to use, the "[/help?cmd=ui|fossil ui]" |
| 73 | command has the "--ckout-alias NAME" option that makes NAME an |
| 74 | alias for "ckout". If you are editing a collection of documents |
| 75 | that have hardcoded links to one another in the form of |
| 76 | "/doc/trunk/...", for example, you can test your changes by |
| 77 | running "fossil ui --ckout-alias trunk" and all of the links will |
| 78 | point to your uncommitted edits rather than to the latest trunk |
| 79 | check-in. |
| 80 | |
| 81 | Finally, the <i><filename></i> element of the URL is the |
| 82 | pathname of the documentation file relative to the root of the source |
| 83 | tree. |
| 84 | |
| 85 |