[PATCH] cvsexportcommit: add some examples to the documentation

[PATCH] cvsexportcommit: add some examples to the documentation

[Martin Langhoff]

Updated with Randall Schwartz's suggestion

Signed-off-by: Martin Langhoff <martin@catalyst.net.nz>


---

 Documentation/git-cvsexportcommit.txt |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)

69c980351a6d74d033a8d70fb37970c71ff8e855
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 13cbf3b..e2540fb 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -17,6 +17,7 @@ Exports a commit from GIT to a CVS check
 to merge patches from a git repository into a CVS repository. 
 
 Execute it from the root of the CVS working copy. GIT_DIR must be defined. 
+See examples below.
 
 It does its best to do the safe thing, it will check that the files are 
 unchanged and up to date in the CVS checkout, and it will not autocommit 
@@ -41,6 +42,26 @@ OPTIONS
 -v::
 	Verbose.
 
+EXAMPLES
+--------
+
+Merge one patch into CVS::
++
+------------
+$ export GIT_DIR=~/project/.git
+$ cd ~/project_cvs_checkout
+$ git-cvsexportcommit -v <commit-sha1>
+$ cvs commit -F .mgs <files> 
+------------
+
+Merge pending patches into CVS automatically -- only if you really know what you are doing ::
++
+------------
+$ export GIT_DIR=~/project/.git
+$ cd ~/project_cvs_checkout
+$ git-cherry cvshead myhead | sed 's/^+ //p' | xargs -l1 git-cvsexportcommit -c -p -v
+------------
+
 Author
 ------
 Written by Martin Langhoff <martin@catalyst.net.nz>
-- 
1.1.6.g170f-dirty

Re: [PATCH] cvsexportcommit: add some examples to the documentation

[Randal L. Schwartz]

>>>>> "Martin" == Martin Langhoff <martin@catalyst.net.nz> writes:

Martin> +$ git-cherry cvshead myhead | sed 's/^+ //p' | xargs -l1 git-cvsexportcommit -c -p -v

But you forgot the -n. :)


-- 
Randal L. Schwartz - Stonehenge Consulting Services, Inc. - +1 503 777 0095
<merlyn@stonehenge.com> <URL:http://www.stonehenge.com/merlyn/>
Perl/Unix/security consulting, Technical writing, Comedy, etc. etc.
See PerlTraining.Stonehenge.com for onsite and open-enrollment Perl training!

[PATCH] cvsexportcommit: add some examples to the documentation

[Martin Langhoff]

Updated with Randall Schwartz's suggestion.

Signed-off-by: Martin Langhoff <martin@catalyst.net.nz>


---

Apologies! One of these days I'll get it right on the first try ;-)

 Documentation/git-cvsexportcommit.txt |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)

69c980351a6d74d033a8d70fb37970c71ff8e855
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 13cbf3b..e2540fb 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -17,6 +17,7 @@ Exports a commit from GIT to a CVS check
 to merge patches from a git repository into a CVS repository. 
 
 Execute it from the root of the CVS working copy. GIT_DIR must be defined. 
+See examples below.
 
 It does its best to do the safe thing, it will check that the files are 
 unchanged and up to date in the CVS checkout, and it will not autocommit 
@@ -41,6 +42,26 @@ OPTIONS
 -v::
 	Verbose.
 
+EXAMPLES
+--------
+
+Merge one patch into CVS::
++
+------------
+$ export GIT_DIR=~/project/.git
+$ cd ~/project_cvs_checkout
+$ git-cvsexportcommit -v <commit-sha1>
+$ cvs commit -F .mgs <files> 
+------------
+
+Merge pending patches into CVS automatically -- only if you really know what you are doing ::
++
+------------
+$ export GIT_DIR=~/project/.git
+$ cd ~/project_cvs_checkout
+$ git-cherry cvshead myhead | sed -n 's/^+ //p' | xargs -l1 git-cvsexportcommit -c -p -v
+------------
+
 Author
 ------
 Written by Martin Langhoff <martin@catalyst.net.nz>
-- 
1.1.6.g170f-dirty

Re: [PATCH] cvsexportcommit: add some examples to the documentation

[Junio C Hamano]

Thanks both.

[PATCH] cvsexportcommit: add some examples to the documentation

[Martin Langhoff]

Signed-off-by: Martin Langhoff <martin@catalyst.net.nz>


---

 Documentation/git-cvsexportcommit.txt |   21 +++++++++++++++++++++
 1 files changed, 21 insertions(+), 0 deletions(-)

69c980351a6d74d033a8d70fb37970c71ff8e855
diff --git a/Documentation/git-cvsexportcommit.txt b/Documentation/git-cvsexportcommit.txt
index 13cbf3b..e2540fb 100644
--- a/Documentation/git-cvsexportcommit.txt
+++ b/Documentation/git-cvsexportcommit.txt
@@ -17,6 +17,7 @@ Exports a commit from GIT to a CVS check
 to merge patches from a git repository into a CVS repository. 
 
 Execute it from the root of the CVS working copy. GIT_DIR must be defined. 
+See examples below.
 
 It does its best to do the safe thing, it will check that the files are 
 unchanged and up to date in the CVS checkout, and it will not autocommit 
@@ -41,6 +42,26 @@ OPTIONS
 -v::
 	Verbose.
 
+EXAMPLES
+--------
+
+Merge one patch into CVS::
++
+------------
+$ export GIT_DIR=~/project/.git
+$ cd ~/project_cvs_checkout
+$ git-cvsexportcommit -v <commit-sha1>
+$ cvs commit -F .mgs <files> 
+------------
+
+Merge pending patches into CVS automatically -- only if you really know what you are doing ::
++
+------------
+$ export GIT_DIR=~/project/.git
+$ cd ~/project_cvs_checkout
+$ git-cherry cvshead myhead | grep '^+' | sed 's/^+ //' | xargs -l1 git-cvsexportcommit -c -p -v
+------------
+
 Author
 ------
 Written by Martin Langhoff <martin@catalyst.net.nz>
-- 
1.1.6.g170f-dirty

Re: [PATCH] cvsexportcommit: add some examples to the documentation

[Randal L. Schwartz]

>>>>> "Martin" == Martin Langhoff <martin@catalyst.net.nz> writes:

Martin> +$ git-cherry cvshead myhead | grep '^+' | sed 's/^+ //' | xargs -l1 git-cvsexportcommit -c -p -v

My idiom for that grep/sed would be:

  ... | sed -n 's/^+ //p' | ...

Then the grep is not needed, because you're printing only the ones
that you've also modified in a useful way.

Yes, I did a heckuva lot more shell programming long before Perl existed. :)

-- 
Randal L. Schwartz - Stonehenge Consulting Services, Inc. - +1 503 777 0095
<merlyn@stonehenge.com> <URL:http://www.stonehenge.com/merlyn/>
Perl/Unix/security consulting, Technical writing, Comedy, etc. etc.
See PerlTraining.Stonehenge.com for onsite and open-enrollment Perl training!