[FFmpeg-devel] [PATCH 2/6] docs: add example around the suggested commit message format
James Darnley
james.darnley at gmail.com
Fri Sep 12 01:31:26 CEST 2014
It gets rendered inline in HTML and becomes not very clear.
---
doc/developer.texi | 3 +++
1 file changed, 3 insertions(+)
diff --git a/doc/developer.texi b/doc/developer.texi
index e51e97a..f1fed5b 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:
+
+ at example
area changed: Short 1 line description
details describing what and why and giving references.
+ at end example
@item
Make sure the author of the commit is set correctly. (see @code{git commit --author})
--
2.0.4
More information about the ffmpeg-devel
mailing list