From e3fb2b0eb7c5e420fc23e015c95b9c3e42abb2bf Mon Sep 17 00:00:00 2001 From: James Darnley Date: Fri, 12 Sep 2014 01:31:26 +0200 Subject: [PATCH] docs: add example around the suggested commit message format It gets rendered inline in HTML and becomes not very clear. Reviewed-by: Timothy Gu Signed-off-by: Michael Niedermayer --- doc/developer.texi | 3 +++ 1 file changed, 3 insertions(+) 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)