[asterisk-dev] [Code Review] Document Commit Message Formatting Information

[Steve Murphy]

-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://reviewboard.digium.com/r/96/#review237
-----------------------------------------------------------


I've been adding the (closes issue #1234) at the top of the commit body, and had a superstitious belief that doing it further down got it ignored... lol

None of this looks unreasonable; uniformity will make life easier in the end.

- Steve


On 2008-12-17 15:22:10, Russell Bryant wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.digium.com/r/96/
> -----------------------------------------------------------
> 
> (Updated 2008-12-17 15:22:10)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Summary
> -------
> 
> This patch adds a new doxygen developer documentation page that covers commit message formatting.  We have a number of special tags and such that can be used, and this documents how to use them, and what commit messages should look like in general.
> 
> The one thing that this covers that isn't done very often today is always having a one line summary at the top of the commit message, but I feel that this is something we should start doing as a standard thing.
> 
> 
> Diffs
> -----
> 
>   /trunk/include/asterisk/doxyref.h 165318 
> 
> Diff: http://reviewboard.digium.com/r/96/diff
> 
> 
> Testing
> -------
> 
> I ran "make progdocs" and viewed the resulting documentation.
> 
> 
> Thanks,
> 
> Russell
> 
>