Browse Source

docs: add example around the suggested commit message format

It gets rendered inline in HTML and becomes not very clear.

Reviewed-by: Timothy Gu <timothygu99@gmail.com>
Signed-off-by: Michael Niedermayer <michaelni@gmx.at>
tags/n2.4
James Darnley Michael Niedermayer 11 years ago
parent
commit
e3fb2b0eb7
1 changed files with 3 additions and 0 deletions
  1. +3
    -0
      doc/developer.texi

+ 3
- 0
doc/developer.texi View File

@@ -323,9 +323,12 @@ Always fill out the commit log message. Describe in a few lines what you
changed and why. You can refer to mailing list postings if you fix a
particular bug. Comments such as "fixed!" or "Changed it." are unacceptable.
Recommended format:

@example
area changed: Short 1 line description

details describing what and why and giving references.
@end example

@item
Make sure the author of the commit is set correctly. (see git commit --author)


Loading…
Cancel
Save