aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorSimon Josefsson <simon@josefsson.org>2008-08-27 12:03:53 +0200
committerSimon Josefsson <simon@josefsson.org>2008-08-27 12:03:53 +0200
commitf15a75046eaa4314a2ddefb126ab6987688eb41f (patch)
tree80abee10be755d6c9fd60126e5437046a4598e2b
parentc74aadd07956fc78ad58dd4d2c2a3f2b2a0c5158 (diff)
downloadgit2cl-f15a75046eaa4314a2ddefb126ab6987688eb41f.zip
git2cl-f15a75046eaa4314a2ddefb126ab6987688eb41f.tar.gz
git2cl-f15a75046eaa4314a2ddefb126ab6987688eb41f.tar.bz2
Fix.
-rw-r--r--README21
1 files changed, 16 insertions, 5 deletions
diff --git a/README b/README
index c9bbce4..79f3d67 100644
--- a/README
+++ b/README
@@ -4,8 +4,17 @@ git2cl
This is a quick'n'dirty tool to convert git logs to GNU ChangeLog
format.
-The tool expects output from 'git log --pretty --numstat --summary' on
-stdin. Thus, typically you would use it as follows:
+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 the 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
@@ -16,9 +25,6 @@ The output format is specified by:
link:http://www.gnu.org/prep/standards/html_node/Change-Logs.html[]
-In the future, git2cl may be modified to run this command itself,
-similar to how cvs2cl works.
-
My inspiration for writing this tool was the
link:http://www.red-bean.com/cvs2cl/[cvs2cl] tool, which I am using in
several projects. Replacing it is a necessary condition for me to
@@ -31,6 +37,11 @@ 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
-------