Re: [Glsdk-devel] build system

[Jason M. <ko...@gm...>]

Henri Häkkinen wrote:
> That is a good idea too. I have made only one commit which had the 
> message "added glm test suite".
>
> I propose we should use the subproject name enclosed in square 
> brackets at the beginning of the message. So for GLM I would use [GLM] 
> or [glm]. Also we should decide on the format of the commit messages. 
> Should we use complete sentences? How comprehensive messages do we 
> need to use? Do we list each files which are modified and every 
> modification done (the GNU convention)?
>
>
> On Sat, Aug 23, 2008 at 11:16 PM, Jason McKesson <ko...@gm... 
> <mailto:ko...@gm...>> wrote:
>
>     Actually, at work we have certain conventions in terms of what commit
>     messages we use. So, if you're working on animation code, you use
>     "CODE_ANIM", if you're checking in animation work, you use "ANIM", and
>     so forth. If we simply define a set of conventions that we
>     consistently
>     use, we should be able to build a change log for a sub-project
>     directly
>     from the SVN commit messages.
>
>
>
>
> -- 
> Henri 'henux' Häkkinen
>
We should not list the files that were modified: SVN changelists can 
already tell you what files were modified. And the description should be 
sufficient to tell you what those modifications entailed. If any more 
detailed information is necessary, a quick trip to SVN-diff can tell you 
anything more. Taking time to detail every file's revision is highly 
unnecessary.

As for the particular convention, brackets are probably a good idea, 
since they allow a tool to be faster at detecting which modules were 
changed.