On Fri, May 13, 2011 at 3:22 AM, Saptarshi Mandal <sapta.iit...@gmail.com>wrote:

> Doing a git log shows that commit messages typically follow no clear
> pattern.
> The same can be said for patches too.
>

I was playing around with git output last night, and a command such as this
produces nice, clear output:

 git log --pretty=medium --reverse sympy-0.6.7..HEAD


medium is to print the level of detail like in your examples, --reverse is
to print oldest first (I feel that's a better approach in this case), and
the last bit prints just the commits between the given tag and HEAD. You can
add in --stat there to get the files changed, too. After some tinkering
around, I wrote a following custom output which further condenses (as 20k
lines and 2k commits is big however you look at it):


git log --pretty=format:'%Cred%h: %an, %ad%n%Creset%+s%n%+b' --reverse
sympy-0.6.7..HEAD


(check it out, it prints a line in red with the commit shorthash, author
name and commit date, and the text after. It can be combined with --stat,
too)


In any case, I intend to go through it all during today and tomorrow, but
any help is welcome!



As to the bigger issue of actually writing the logs, we could try to write
more verbose commit messages (ie. kernel-style), we could make people edit
some changelog file with every change they make (but this would lead to
plentiful merge commits with that file), or we could simply release more
often! I prefer the third option, for what it's worth.


>
> For example
> ...
> commit 0f7f4fbc268545651860d7d41b03269225a9c866
> Author: Ronan Lamy <ronan.l...@normalesup.org>
> Date:   Tue Apr 26 01:10:12 2011 +0100
>
>    Fix doctests for keep_sign = True
>
> commit 819b28a088c3d7152291006f0b5e353966d99218
> Author: Ronan Lamy <ronan.l...@normalesup.org>
> Date:   Tue Apr 26 00:57:30 2011 +0100
>
>    Fixed tests for keep_sign = True
>
> commit b8d6252ea115032f7da8c46aca60af0b6a75fd36
> Author: Ronan Lamy <ronan.l...@normalesup.org>
> Date:   Thu Jan 13 23:43:00 2011 +0000
>
>    Set keep_sign = True
>
> On inspection I do not know which subsystem this changes. I will need
> to do
> a git show for that but I have no interest in looking at the code as
> it has already
> passed review. A more helpful message would be
>
> sympy/core: Set keep_sign = True
>
> so atleast I know which part has changed.
>
> I would also like to know why this was changed. If this does not fix a
> bug some
> lines explaining it should be necessary.
> See for ex commit f88580a627eaaed2ae57ba3566d1fb668faf4306
>
> Another thing is that tests and doctests should have been in one
> single commit.
>
> Could we also enforce the signoff?
>
> Documentation will be easier if all the patches follow some sort of
> guidelines or
> semantic rules.
>
> --
> You received this message because you are subscribed to the Google Groups
> "sympy" group.
> To post to this group, send email to sympy@googlegroups.com.
> To unsubscribe from this group, send email to
> sympy+unsubscr...@googlegroups.com.
> For more options, visit this group at
> http://groups.google.com/group/sympy?hl=en.
>
>


-- 
Vlada Perić

-- 
You received this message because you are subscribed to the Google Groups 
"sympy" group.
To post to this group, send email to sympy@googlegroups.com.
To unsubscribe from this group, send email to 
sympy+unsubscr...@googlegroups.com.
For more options, visit this group at 
http://groups.google.com/group/sympy?hl=en.

Reply via email to