Fossil SCM
The "Summary Line Convention In Commit Comments" section in gitusers.md now covers the related setting under Admin -> Timeline.
Commit
c33ffed3ebfe4beaaaf48325780afe50d8bba10067ed89906917e2e374f90e26
Parent
a58d952fa68c195…
1 file changed
+15
-13
+15
-13
| --- www/gitusers.md | ||
| +++ www/gitusers.md | ||
| @@ -440,23 +440,25 @@ | ||
| 440 | 440 | |
| 441 | 441 | |
| 442 | 442 | ## <a id="slcom"></a> Summary Line Convention In Commit Comments |
| 443 | 443 | |
| 444 | 444 | The Git convention of a [length-limited summary line][lsl] at the start |
| 445 | -of commit comments has no equivalent in Fossil. You’re welcome to style | |
| 446 | -your commit comments thus, but the convention isn’t used or enforced | |
| 447 | -anywhere in Fossil. For instance, setting `EDITOR=vim` and making a | |
| 448 | -commit doesn’t do syntax highlighting on the commit message to warn that | |
| 449 | -you’ve gone over the conventional limit on the first line, and the | |
| 450 | -Fossil web timeline display doesn’t show the summary line in bold. | |
| 451 | - | |
| 452 | -If you wish to follow such conventions in a Fossil project, you may want | |
| 453 | -to enable the “Allow block-markup in timeline” setting under Admin → | |
| 454 | -Timeline in the web UI to prevent Fossil from showing the message as a | |
| 455 | -single paragraph, sans line breaks. [Skin customization][cskin] would | |
| 456 | -allow you to style the first line of the commit message in bold in | |
| 457 | -`/timeline` views. | |
| 445 | +of commit comments is not enforced or obeyed by default in Fossil. | |
| 446 | +However, there is a setting under Admin → Timeline → “Truncate comment | |
| 447 | +at first blank line (Git-style)” to change this for `/timeline` | |
| 448 | +displays. Alternately, you could enable the “Allow block-markup in | |
| 449 | +timeline” setting under Admin → Timeline, then apply [local skin | |
| 450 | +customizations][cskin] to put that first comment in in bold or whatever | |
| 451 | +suits. | |
| 452 | + | |
| 453 | +Because this isn’t a typical Fossil convention, you’re likely to find | |
| 454 | +other odd differences between it and Git-based infrastructure. For | |
| 455 | +instance, Vim doesn’t ship with syntax support for Fossil commit | |
| 456 | +messages if you set `EDITOR=vim` in your shell environment, so you won’t | |
| 457 | +get over-limit highlighting for first-line text beyond the 50th | |
| 458 | +character and such, because it doesn’t recognize Fossil commit messages | |
| 459 | +and apply similar rules as to Git commit messages. | |
| 458 | 460 | |
| 459 | 461 | [cskin]: ./customskin.md |
| 460 | 462 | [lsl]: https://chris.beams.io/posts/git-commit/#limit-50 |
| 461 | 463 | |
| 462 | 464 | |
| 463 | 465 |
| --- www/gitusers.md | |
| +++ www/gitusers.md | |
| @@ -440,23 +440,25 @@ | |
| 440 | |
| 441 | |
| 442 | ## <a id="slcom"></a> Summary Line Convention In Commit Comments |
| 443 | |
| 444 | The Git convention of a [length-limited summary line][lsl] at the start |
| 445 | of commit comments has no equivalent in Fossil. You’re welcome to style |
| 446 | your commit comments thus, but the convention isn’t used or enforced |
| 447 | anywhere in Fossil. For instance, setting `EDITOR=vim` and making a |
| 448 | commit doesn’t do syntax highlighting on the commit message to warn that |
| 449 | you’ve gone over the conventional limit on the first line, and the |
| 450 | Fossil web timeline display doesn’t show the summary line in bold. |
| 451 | |
| 452 | If you wish to follow such conventions in a Fossil project, you may want |
| 453 | to enable the “Allow block-markup in timeline” setting under Admin → |
| 454 | Timeline in the web UI to prevent Fossil from showing the message as a |
| 455 | single paragraph, sans line breaks. [Skin customization][cskin] would |
| 456 | allow you to style the first line of the commit message in bold in |
| 457 | `/timeline` views. |
| 458 | |
| 459 | [cskin]: ./customskin.md |
| 460 | [lsl]: https://chris.beams.io/posts/git-commit/#limit-50 |
| 461 | |
| 462 | |
| 463 |
| --- www/gitusers.md | |
| +++ www/gitusers.md | |
| @@ -440,23 +440,25 @@ | |
| 440 | |
| 441 | |
| 442 | ## <a id="slcom"></a> Summary Line Convention In Commit Comments |
| 443 | |
| 444 | The Git convention of a [length-limited summary line][lsl] at the start |
| 445 | of commit comments is not enforced or obeyed by default in Fossil. |
| 446 | However, there is a setting under Admin → Timeline → “Truncate comment |
| 447 | at first blank line (Git-style)” to change this for `/timeline` |
| 448 | displays. Alternately, you could enable the “Allow block-markup in |
| 449 | timeline” setting under Admin → Timeline, then apply [local skin |
| 450 | customizations][cskin] to put that first comment in in bold or whatever |
| 451 | suits. |
| 452 | |
| 453 | Because this isn’t a typical Fossil convention, you’re likely to find |
| 454 | other odd differences between it and Git-based infrastructure. For |
| 455 | instance, Vim doesn’t ship with syntax support for Fossil commit |
| 456 | messages if you set `EDITOR=vim` in your shell environment, so you won’t |
| 457 | get over-limit highlighting for first-line text beyond the 50th |
| 458 | character and such, because it doesn’t recognize Fossil commit messages |
| 459 | and apply similar rules as to Git commit messages. |
| 460 | |
| 461 | [cskin]: ./customskin.md |
| 462 | [lsl]: https://chris.beams.io/posts/git-commit/#limit-50 |
| 463 | |
| 464 | |
| 465 |