README.md

   1 # git2cl
   2
   3 Convert `git` logs to GNU ChangeLog format.
   4
   5 # License
   6
   7 The git2cl tool is released under the GPLv3+.  See the file
   8 [COPYING](COPYING) for detailed information.
   9
  10 # Usage
  11
  12 The tool invokes 'git log' internally unless you pipe a log to it.
  13 Thus, typically you would use it as follows:
  14
  15 ```
  16 jas@mocca:~/src/libtasn1$ git2cl > ChangeLog
  17 jas@mocca:~/src/libtasn1$
  18 ```
  19
  20 If you don't want git2cl to invoke git log internally, you can use it
  21 as a pipe.  It needs a git log generated with --pretty --numstat and
  22 --summary.  You can use it as follows:
  23
  24 ```
  25 jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | git2cl > ChangeLog
  26 jas@mocca:~/src/libtasn1$
  27 ```
  28
  29 The output format is specified by the [GNU ChangeLog
  30 format](http://www.gnu.org/prep/standards/html_node/Change-Logs.html).
  31
  32 My inspiration for writing this tool was the
  33 [cvs2cl](http://www.red-bean.com/cvs2cl/) tool, which I have been
  34 using in several projects.  Replacing it was necessary to seriously
  35 consider switching from CVS to GIT for my projects.
  36
  37 There is a [Savannah git2cl
  38 project](https://savannah.nongnu.org/projects/git2cl/) and a [GitLab
  39 git2cl project](https://gitlab.com/jas/git2cl). An old repository is
  40 still at [http://repo.or.cz/w/git2cl.git].
  41
  42 # Related work
  43
  44 The [gnulib](https://www.gnu.org/software/gnulib/) project offers a
  45 tool called [gitlog-to-changelog](https://www.gnu.org/software/gnulib/manual/html_node/gitlog_002dto_002dchangelog.html) which is similar.
  46
  47 The `git` tool itself has evolved since `git2cl` was created, and one
  48 command to achieve somewhat different output would be:
  49
  50 ```
  51 git log --pretty="format:%ad  %aN  <%aE>%n%n%x09* %s%n" --date=short
  52 ```
  53
  54 # Credits
  55
  56 Luis Mondesi contributed several improvements.
  57
  58 # Support
  59
  60 Try talking to [simon@josefsson.org](Simon Josefsson).