README

   1 git2cl
   2 ======
   3
   4 This is a quick'n'dirty tool to convert git logs to GNU ChangeLog
   5 format.
   6
   7 The tool invokes 'git log' internally unless you pipe a log to it.
   8 Thus, typically you would use it as follows:
   9
  10 ...........................................................................
  11 jas@mocca:~/src/libtasn1$ git2cl > ChangeLog
  12 jas@mocca:~/src/libtasn1$
  13 ...........................................................................
  14
  15 If you don't want git2cl to invoke git log internally, you can use it
  16 as a pipe.  It needs the git log generated with --pretty --numstat and
  17 --summary.  You can use it as follows:
  18
  19 ...........................................................................
  20 jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | ~/src/git2cl/git2cl > ChangeLog
  21 jas@mocca:~/src/libtasn1$
  22 ...........................................................................
  23
  24 The output format is specified by:
  25
  26 link:http://www.gnu.org/prep/standards/html_node/Change-Logs.html[]
  27
  28 My inspiration for writing this tool was the
  29 link:http://www.red-bean.com/cvs2cl/[cvs2cl] tool, which I am using in
  30 several projects.  Replacing it is a necessary condition for me to
  31 seriously consider switching from CVS to GIT for my projects.
  32
  33 Currently, git2cl lacks much of the flexibility in git2cl.  Sheesh,
  34 git2cl doesn't even have command line parameters!
  35
  36 The canonical home page for git2cl is:
  37 link:http://josefsson.org/git2cl/[] and its repository can be found at
  38 link:http://repo.or.cz/w/git2cl.git[].
  39
  40 Credits
  41 -------
  42
  43 Luis Mondesi contributed several improvements.
  44
  45 Support
  46 -------
  47
  48 Try talking to mailto:simon@josefsson.org[Simon Josefsson].