Fossil SCM
mention 'ckout' as pseudo-tag for previewing changes to embedded documentation in Check-in Names page
Commit
d282fc18d47347c909fbfdb5e3e50f34a2c6246c
Parent
915d61933c0a3a4…
1 file changed
+7
| --- www/checkin_names.wiki | ||
| +++ www/checkin_names.wiki | ||
| @@ -15,10 +15,11 @@ | ||
| 15 | 15 | <ul> |
| 16 | 16 | <li> <b>tip</b> |
| 17 | 17 | <li> <b>current</b> |
| 18 | 18 | <li> <b>next</b> |
| 19 | 19 | <li> <b>previous</b> or <b>prev</b> |
| 20 | +<li> <b>ckout</b> for embedded docs | |
| 20 | 21 | </ul> |
| 21 | 22 | </ul> |
| 22 | 23 | </td></tr> |
| 23 | 24 | </table> |
| 24 | 25 | Many Fossil [/help|commands] and [./webui.wiki | web-interface] URLs accept |
| @@ -216,10 +217,16 @@ | ||
| 216 | 217 | If the command is being run from a working check-out (not against a bare |
| 217 | 218 | repository) then a few extra tags apply. The "current" tag means the |
| 218 | 219 | current check-out. The "next" tag means the youngest child of the |
| 219 | 220 | current check-out. And the "previous" or "prev" tag means the primary |
| 220 | 221 | (non-merge) parent of the current check-out. |
| 222 | + | |
| 223 | +For embedded documentation, the tag "ckout" means the version as present in | |
| 224 | +the local source tree on disk, provided that the web server is started using | |
| 225 | +"fossil ui" or "fossil server" from within the source tree. This tag can be | |
| 226 | +used to preview local changes to documentation before committing them. It does | |
| 227 | +not apply to CLI commands. | |
| 221 | 228 | |
| 222 | 229 | <h2>Additional Examples</h2> |
| 223 | 230 | |
| 224 | 231 | To view the changes in the most recent check-in prior to the version currently |
| 225 | 232 | checked out: |
| 226 | 233 |
| --- www/checkin_names.wiki | |
| +++ www/checkin_names.wiki | |
| @@ -15,10 +15,11 @@ | |
| 15 | <ul> |
| 16 | <li> <b>tip</b> |
| 17 | <li> <b>current</b> |
| 18 | <li> <b>next</b> |
| 19 | <li> <b>previous</b> or <b>prev</b> |
| 20 | </ul> |
| 21 | </ul> |
| 22 | </td></tr> |
| 23 | </table> |
| 24 | Many Fossil [/help|commands] and [./webui.wiki | web-interface] URLs accept |
| @@ -216,10 +217,16 @@ | |
| 216 | If the command is being run from a working check-out (not against a bare |
| 217 | repository) then a few extra tags apply. The "current" tag means the |
| 218 | current check-out. The "next" tag means the youngest child of the |
| 219 | current check-out. And the "previous" or "prev" tag means the primary |
| 220 | (non-merge) parent of the current check-out. |
| 221 | |
| 222 | <h2>Additional Examples</h2> |
| 223 | |
| 224 | To view the changes in the most recent check-in prior to the version currently |
| 225 | checked out: |
| 226 |
| --- www/checkin_names.wiki | |
| +++ www/checkin_names.wiki | |
| @@ -15,10 +15,11 @@ | |
| 15 | <ul> |
| 16 | <li> <b>tip</b> |
| 17 | <li> <b>current</b> |
| 18 | <li> <b>next</b> |
| 19 | <li> <b>previous</b> or <b>prev</b> |
| 20 | <li> <b>ckout</b> for embedded docs |
| 21 | </ul> |
| 22 | </ul> |
| 23 | </td></tr> |
| 24 | </table> |
| 25 | Many Fossil [/help|commands] and [./webui.wiki | web-interface] URLs accept |
| @@ -216,10 +217,16 @@ | |
| 217 | If the command is being run from a working check-out (not against a bare |
| 218 | repository) then a few extra tags apply. The "current" tag means the |
| 219 | current check-out. The "next" tag means the youngest child of the |
| 220 | current check-out. And the "previous" or "prev" tag means the primary |
| 221 | (non-merge) parent of the current check-out. |
| 222 | |
| 223 | For embedded documentation, the tag "ckout" means the version as present in |
| 224 | the local source tree on disk, provided that the web server is started using |
| 225 | "fossil ui" or "fossil server" from within the source tree. This tag can be |
| 226 | used to preview local changes to documentation before committing them. It does |
| 227 | not apply to CLI commands. |
| 228 | |
| 229 | <h2>Additional Examples</h2> |
| 230 | |
| 231 | To view the changes in the most recent check-in prior to the version currently |
| 232 | checked out: |
| 233 |