[FFmpeg-cvslog] doc: Extend commit message section

Derek Buitenhuis git at videolan.org
Tue Jan 8 13:02:54 CET 2013


ffmpeg | branch: master | Derek Buitenhuis <derek.buitenhuis at gmail.com> | Sun Jan  6 13:33:13 2013 -0500| [6042a12174e58f7cfca47de56c372b4164d270ba] | committer: Derek Buitenhuis

doc: Extend commit message section

If a bug exists on the tracker, its ID should always be included
in fix messages.

Also, any relevant bug fixes should be CC'd to libav-stable, so
we can actually track what needs to be backported, instead of
just randomly combing the git history and old CVEs.

Signed-off-by: Derek Buitenhuis <derek.buitenhuis at gmail.com>

> http://git.videolan.org/gitweb.cgi/ffmpeg.git/?a=commit;h=6042a12174e58f7cfca47de56c372b4164d270ba
---

 doc/developer.texi |    9 +++++++--
 1 file changed, 7 insertions(+), 2 deletions(-)

diff --git a/doc/developer.texi b/doc/developer.texi
index 691a907..f24b4fe 100644
--- a/doc/developer.texi
+++ b/doc/developer.texi
@@ -267,8 +267,13 @@ For Emacs, add these roughly equivalent lines to your @file{.emacs.d/init.el}:
    The commit message should have a short first line in the form of
    a @samp{topic: short description} as a header, separated by a newline
    from the body consisting of an explanation of why the change is necessary.
-   Referring to the issue on the bug tracker does not exempt to report an
-   excerpt of the bug.
+   If the commit fixes a known bug on the bug tracker, the commit message
+   should include its bug ID. Referring to the issue on the bug tracker does
+   not exempt you from writing an excerpt of the bug in the commit message.
+   If the patch is a bug fix which should be backported to stable releases,
+   i.e. a non-API/ABI-breaking bug fix, add @code{CC: libav-stable@@libav.org}
+   to the bottom of your commit message, and make sure to CC your patch to
+   this address, too. Some git setups will do this automatically.
 @item
    Work in progress patches should be sent to the mailing list with the [WIP]
    or the [RFC] tag.



More information about the ffmpeg-cvslog mailing list