aboutsummaryrefslogtreecommitdiff
path: root/tools/git2cl/README
diff options
context:
space:
mode:
Diffstat (limited to 'tools/git2cl/README')
m---------tools/git2cl0
-rw-r--r--tools/git2cl/README45
2 files changed, 45 insertions, 0 deletions
diff --git a/tools/git2cl b/tools/git2cl
deleted file mode 160000
-Subproject 8373c9f74993e218a08819cbcdbab3f3564bbeb
diff --git a/tools/git2cl/README b/tools/git2cl/README
new file mode 100644
index 0000000..4084080
--- /dev/null
+++ b/tools/git2cl/README
@@ -0,0 +1,45 @@
+git2cl
+======
+
+This is a quick'n'dirty tool to convert git logs to GNU ChangeLog
+format.
+
+The tool invokes 'git log' internally unless you pipe a log to it.
+Thus, typically you would use it as follows:
+
+...........................................................................
+jas@mocca:~/src/libtasn1$ git2cl > ChangeLog
+jas@mocca:~/src/libtasn1$
+...........................................................................
+
+If you don't want git2cl to invoke git log internally, you can use it
+as a pipe. It needs a git log generated with --pretty --numstat and
+--summary. You can use it as follows:
+
+...........................................................................
+jas@mocca:~/src/libtasn1$ git log --pretty --numstat --summary | ~/src/git2cl/git2cl > ChangeLog
+jas@mocca:~/src/libtasn1$
+...........................................................................
+
+The output format is specified by:
+
+link:http://www.gnu.org/prep/standards/html_node/Change-Logs.html[]
+
+My inspiration for writing this tool was the
+link:http://www.red-bean.com/cvs2cl/[cvs2cl] tool, which I have been
+using in several projects. Replacing it was necessary to seriously
+consider switching from CVS to GIT for my projects.
+
+The canonical home page for git2cl is:
+link:http://josefsson.org/git2cl/[] and its repository can be found at
+link:http://repo.or.cz/w/git2cl.git[].
+
+Credits
+-------
+
+Luis Mondesi contributed several improvements.
+
+Support
+-------
+
+Try talking to mailto:simon@josefsson.org[Simon Josefsson].