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

[Joshua Colp]

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

Ship it!


Yay! All looks good.

- Joshua


On 2008-12-18 07:51:27, Russell Bryant wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.digium.com/r/96/
> -----------------------------------------------------------
> 
> (Updated 2008-12-18 07:51:27)
> 
> 
> 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 165436 
> 
> Diff: http://reviewboard.digium.com/r/96/diff
> 
> 
> Testing
> -------
> 
> I ran "make progdocs" and viewed the resulting documentation.
> 
> 
> Thanks,
> 
> Russell
> 
>