diff options
| author | James Darnley <james.darnley@gmail.com> | 2014-09-12 01:31:26 +0200 |
|---|---|---|
| committer | Michael Niedermayer <michaelni@gmx.at> | 2014-09-12 01:59:44 +0200 |
| commit | e3fb2b0eb7c5e420fc23e015c95b9c3e42abb2bf (patch) | |
| tree | 791f03367e42a031f2e298dd92b88fac13867780 /doc | |
| parent | 453944cc77b9ea27c74011eb7c0e20c887b321cf (diff) | |
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>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/developer.texi | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/doc/developer.texi b/doc/developer.texi index 1e1d3b8c8f..8b1f150ee6 100644 --- a/doc/developer.texi +++ b/doc/developer.texi @@ -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) |