[FFmpeg-devel] [PATCH 1/2] doc/developer: add note on patches that fix warnings

Ganesh Ajjanagadde gajjanagadde at gmail.com
Sun Sep 20 01:35:52 CEST 2015


This adds some recommendations while submitting patches that fix warnings.

Signed-off-by: Ganesh Ajjanagadde <gajjanagadde at gmail.com>
---
 doc/developer.texi | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/doc/developer.texi b/doc/developer.texi
index b8259e7..7324629 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -391,6 +391,12 @@ be changed to not generate a warning unless that causes a slowdown
 or obfuscates the code.
 
 @item
+While fixing compiler warnings, please add some information to the commit
+message body indicating the compiler/environment version or configuration.
+This is very helpful for future maintainers since it eases possible
+modifications when the toolchain gets updated.
+
+ at item
 Make sure that no parts of the codebase that you maintain are missing from the
 @file{MAINTAINERS} file. If something that you want to maintain is missing add it with
 your name after it.
-- 
2.5.2



More information about the ffmpeg-devel mailing list