Invoke git-log if not used as a pipe.
[git2cl.git] / README
blobc9bbce4cf0e52b25930b5da6a7332bb7ceba6995
1 git2cl
2 ======
4 This is a quick'n'dirty tool to convert git logs to GNU ChangeLog
5 format.
7 The tool expects output from 'git log --pretty --numstat --summary' on
8 stdin.  Thus, typically you would use it as follows:
10 ...........................................................................
11 jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | ~/src/git2cl/git2cl > ChangeLog
12 jas@mocca:~/src/libtasn1$
13 ...........................................................................
15 The output format is specified by:
17 link:http://www.gnu.org/prep/standards/html_node/Change-Logs.html[]
19 In the future, git2cl may be modified to run this command itself,
20 similar to how cvs2cl works.
22 My inspiration for writing this tool was the
23 link:http://www.red-bean.com/cvs2cl/[cvs2cl] tool, which I am using in
24 several projects.  Replacing it is a necessary condition for me to
25 seriously consider switching from CVS to GIT for my projects.
27 Currently, git2cl lacks much of the flexibility in git2cl.  Sheesh,
28 git2cl doesn't even have command line parameters!
30 The canonical home page for git2cl is:
31 link:http://josefsson.org/git2cl/[] and its repository can be found at
32 link:http://repo.or.cz/w/git2cl.git[].
34 Support
35 -------
37 Try talking to mailto:simon@josefsson.org[Simon Josefsson].