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

[Mark Michelson]

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



/trunk/include/asterisk/doxyref.h
<http://reviewboard.digium.com/r/96/#comment478>

    For the sake of completeness, I'd make a note that the verbose description is not necessarily required for trivial commits along the lines of "fix the build" or "Fix spacing." Your call really.



/trunk/include/asterisk/doxyref.h
<http://reviewboard.digium.com/r/96/#comment479>

    "usa a tag of the form" instead of "use a of of the form"



/trunk/include/asterisk/doxyref.h
<http://reviewboard.digium.com/r/96/#comment480>

    I'd place a note in here stating that the commit message template may be automatically generated for you if you are a Mantis admin. Point out where on a bug page to click to have this information generated.
    
    This is one of those things that seems pretty obvious to those of us who have been Mantis admins for a while, but for someone new who comes along, it's a good idea to spell this out plainly so they don't go to a lot of effort to manually fit the commit message template.



/trunk/include/asterisk/doxyref.h
<http://reviewboard.digium.com/r/96/#comment481>

    It may be a good idea to place a link here to the asterisk.org page with all the ins and outs of merging using svn.


- Mark


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
> 
>