[FFmpeg-cvslog] docs: add example around the suggested commit message format
git at videolan.org
Fri Sep 12 03:25:56 CEST 2014
ffmpeg | branch: master | James Darnley <james.darnley at gmail.com> | Fri Sep 12 01:31:26 2014 +0200| [e3fb2b0eb7c5e420fc23e015c95b9c3e42abb2bf] | committer: Michael Niedermayer
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 at gmail.com>
Signed-off-by: Michael Niedermayer <michaelni at gmx.at>
doc/developer.texi | 3 +++
1 file changed, 3 insertions(+)
diff --git a/doc/developer.texi b/doc/developer.texi
index 1e1d3b8..8b1f150 100644
@@ -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.
+ at example
area changed: Short 1 line description
details describing what and why and giving references.
+ at end example
Make sure the author of the commit is set correctly. (see git commit --author)
More information about the ffmpeg-cvslog