[FFmpeg-devel] [PATCH 4/6] docs: mention the comment policy

James Darnley james.darnley at gmail.com
Fri Sep 12 01:31:28 CEST 2014

This addresses point 6 from the mplayer patches text file.  Discussion about
removing a link to this document can be found in the thread on ffmpeg-devel
titled: [PATCH] web/contact: replace MPlayer guidelines link
 doc/developer.texi | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/doc/developer.texi b/doc/developer.texi
index 9a90e84..1b020fc 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -398,6 +398,13 @@ Make sure that no parts of the codebase that you maintain are missing from the
 your name after it.
 If at some point you no longer want to maintain some code, then please help
 finding a new maintainer and also don't forget updating the @file{MAINTAINERS} file.
+ at item
+Please comment parts of your code that need it. This should apply to sections
+that are particularly complex or that have tricky side-effects. Always document
+your string operations to show what you are doing and why it is safe.
+Doing this will make it easier to review your changes.
+Finally, comments must be in English.
 @end enumerate
 We think our rules are not too hard. If you have comments, contact us.

More information about the ffmpeg-devel mailing list