highperfocused/ffmpeg
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: Extend commit message section

Browse Source 
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@gmail.com>
This commit is contained in:
Derek Buitenhuis 2013-01-06 13:33:13 -05:00
parent ac2603be28
commit 6042a12174
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/developer.texi
View File

@ -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 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 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. 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 If the commit fixes a known bug on the bug tracker, the commit message
excerpt of the bug. 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 @item
Work in progress patches should be sent to the mailing list with the [WIP] Work in progress patches should be sent to the mailing list with the [WIP]
or the [RFC] tag. or the [RFC] tag.