Fossil SCM
Added the "Summary Line Convention In Commit Comments" section to the gitusers doc.
Commit
46a30e7e9b0cd2b70d6eb572a8101b44e694e4265ccc00b0bd36f35508b3ba25
Parent
c8b414ab8db3f24…
1 file changed
+23
+23
| --- www/gitusers.md | ||
| +++ www/gitusers.md | ||
| @@ -205,10 +205,33 @@ | ||
| 205 | 205 | [infoc]: /help?cmd=info |
| 206 | 206 | [infow]: /help?cmd=/info |
| 207 | 207 | [tlc]: /help?cmd=timeline |
| 208 | 208 | [tlw]: /help?cmd=/timeline |
| 209 | 209 | [wdm]: ./fossil-v-git.wiki#durable |
| 210 | + | |
| 211 | + | |
| 212 | + | |
| 213 | +## <a id="slcom"></a> Summary Line Convention In Commit Comments | |
| 214 | + | |
| 215 | +The Git convention of a [length-limited summary line][lsl] at the start | |
| 216 | +of commit comments has no equivalent in Fossil. You’re welcome to style | |
| 217 | +your commit comments thus, but the convention isn’t used or enforced | |
| 218 | +anywhere in Fossil. For instance, setting `EDITOR=vim` and making a | |
| 219 | +commit doesn’t do syntax highlighting on the commit message to warn that | |
| 220 | +you’ve gone over the conventional limit on the first line, and the | |
| 221 | +Fossil web timeline display doesn’t show the summary line in bold. | |
| 222 | + | |
| 223 | +If you wish to follow such conventions in a Fossil project, you may want | |
| 224 | +to enable the “Allow block-markup in timeline” setting under Admin → | |
| 225 | +Timeline in the web UI to prevent Fossil from showing the message as a | |
| 226 | +single paragraph, sans line breaks. [Skin customization][cskin] would | |
| 227 | +allow you to style the first line of the commit message in bold in | |
| 228 | +`/timeline` views. | |
| 229 | + | |
| 230 | +[cskin]: ./customskin.md | |
| 231 | +[lsl]: https://chris.beams.io/posts/git-commit/#limit-50 | |
| 232 | + | |
| 210 | 233 | |
| 211 | 234 | |
| 212 | 235 | <a id="staging"></a> |
| 213 | 236 | ## There Is No Staging Area |
| 214 | 237 | |
| 215 | 238 |
| --- www/gitusers.md | |
| +++ www/gitusers.md | |
| @@ -205,10 +205,33 @@ | |
| 205 | [infoc]: /help?cmd=info |
| 206 | [infow]: /help?cmd=/info |
| 207 | [tlc]: /help?cmd=timeline |
| 208 | [tlw]: /help?cmd=/timeline |
| 209 | [wdm]: ./fossil-v-git.wiki#durable |
| 210 | |
| 211 | |
| 212 | <a id="staging"></a> |
| 213 | ## There Is No Staging Area |
| 214 | |
| 215 |
| --- www/gitusers.md | |
| +++ www/gitusers.md | |
| @@ -205,10 +205,33 @@ | |
| 205 | [infoc]: /help?cmd=info |
| 206 | [infow]: /help?cmd=/info |
| 207 | [tlc]: /help?cmd=timeline |
| 208 | [tlw]: /help?cmd=/timeline |
| 209 | [wdm]: ./fossil-v-git.wiki#durable |
| 210 | |
| 211 | |
| 212 | |
| 213 | ## <a id="slcom"></a> Summary Line Convention In Commit Comments |
| 214 | |
| 215 | The Git convention of a [length-limited summary line][lsl] at the start |
| 216 | of commit comments has no equivalent in Fossil. You’re welcome to style |
| 217 | your commit comments thus, but the convention isn’t used or enforced |
| 218 | anywhere in Fossil. For instance, setting `EDITOR=vim` and making a |
| 219 | commit doesn’t do syntax highlighting on the commit message to warn that |
| 220 | you’ve gone over the conventional limit on the first line, and the |
| 221 | Fossil web timeline display doesn’t show the summary line in bold. |
| 222 | |
| 223 | If you wish to follow such conventions in a Fossil project, you may want |
| 224 | to enable the “Allow block-markup in timeline” setting under Admin → |
| 225 | Timeline in the web UI to prevent Fossil from showing the message as a |
| 226 | single paragraph, sans line breaks. [Skin customization][cskin] would |
| 227 | allow you to style the first line of the commit message in bold in |
| 228 | `/timeline` views. |
| 229 | |
| 230 | [cskin]: ./customskin.md |
| 231 | [lsl]: https://chris.beams.io/posts/git-commit/#limit-50 |
| 232 | |
| 233 | |
| 234 | |
| 235 | <a id="staging"></a> |
| 236 | ## There Is No Staging Area |
| 237 | |
| 238 |