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>

diff --git a/doc/developer.texi b/doc/developer.texi
index 1e1d3b8c8f292816d0f63ae9f8918de12cc59e26..8b1f150ee6499e283090601b158cb87026cce656 100644 (file)
--- 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)