threads / patch / 27161

patch, 2 partsDocumentation fixes for git-svn.txt

Subject: [PATCH 0/2] Documentation fixes for git-svn.txt

## tl;dr

9 messages between Apr 22, 2011 and Apr 26, 2011. Diffs are folded; open one to read it.

replies: 8people: 3as markdown or json

Valentin Haenel· Apr 22, 2011, 17:03 UTC · lore

Hi,

the command documentation for 'git svn fetch' lists the following two options:

  --use-log-author

and

  --add-author-from

However, as the current description of both states, they are also applicable to 'git svn' subcommands other than fetch. The first patch moves them, the second patch applies some cosmetics.

My remaining question regarding the second option, '--add-author-from', is about the subcommands which it is applicable to. The current documentation states 'commit' and 'dcommit'. My feeling is that 'commit' is a typo, since 'git svn' does not have a 'commit' subcommand. I had a look at the code, and while I am not familiar with perl, it seems to me that the three subcommands that use the option are 'commit-diff', 'set-tree' and 'dcommit'. But this is non-trivial -- feedback is appreciated.

V-

Valentin Haenel (2):
  git-svn.txt: move option descriptions
  git-svn.txt: small typeface improvements

 Documentation/git-svn.txt |   23 ++++++++++++-----------
 1 files changed, 12 insertions(+), 11 deletions(-)

Valentin Haenel· Apr 22, 2011, 17:03 UTC · re: Valentin Haenel · lore

[PATCH 1/2] git-svn.txt: move option descriptions

The options '---use-log-author' and '--add-author-from' are applicable to other subcommands except 'fetch' -- therefore move them from the 'fetch' section to the more general 'options' section

Signed-off-by: Valentin Haenel <valentin.haenel@gmx.de>
---
 Documentation/git-svn.txt |   22 +++++++++++-----------
 1 files changed, 11 insertions(+), 11 deletions(-)

Show changes to Documentation/git-svn.txt +11 −9

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 30a6748..e12f9f8 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -145,17 +145,6 @@ Skip "branches" and "tags" of first level directories;;
 ------------------------------------------------------------------------
 --
 
---use-log-author;;
-	When retrieving svn commits into git (as part of fetch, rebase, or
-	dcommit operations), look for the first From: or Signed-off-by: line
-	in the log message and use that as the author string.
---add-author-from;;
-	When committing to svn from git (as part of commit or dcommit
-	operations), if the existing log message doesn't already have a
-	From: or Signed-off-by: line, append a From: line based on the
-	git commit's author string.  If you use this, then --use-log-author
-	will retrieve a valid author string for all commits.
-
 'clone'::
 	Runs 'init' and 'fetch'.  It will automatically create a
 	directory based on the basename of the URL passed to it;
@@ -572,6 +561,17 @@ repository that will be fetched from.
 For 'branch' and 'tag', display the urls that will be used for copying when
 creating the branch or tag.
 
+--use-log-author::
+	When retrieving svn commits into git (as part of fetch, rebase, or
+	dcommit operations), look for the first From: or Signed-off-by: line
+	in the log message and use that as the author string.
+--add-author-from::
+	When committing to svn from git (as part of commit or dcommit
+	operations), if the existing log message doesn't already have a
+	From: or Signed-off-by: line, append a From: line based on the
+	git commit's author string.  If you use this, then --use-log-author
+	will retrieve a valid author string for all commits.
+
 
 ADVANCED OPTIONS
 ----------------

-- 
1.7.1

Valentin Haenel· Apr 22, 2011, 17:03 UTC · re: Valentin Haenel · lore

[PATCH 2/2] git-svn.txt: small typeface improvements

Signed-off-by: Valentin Haenel <valentin.haenel@gmx.de>
---
 Documentation/git-svn.txt |   11 ++++++-----
 1 files changed, 6 insertions(+), 5 deletions(-)

Show changes to Documentation/git-svn.txt +6 −4

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index e12f9f8..5c75d71 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -562,14 +562,15 @@ For 'branch' and 'tag', display the urls that will be used for copying when
 creating the branch or tag.
 
 --use-log-author::
-	When retrieving svn commits into git (as part of fetch, rebase, or
-	dcommit operations), look for the first From: or Signed-off-by: line
+	When retrieving svn commits into git (as part of 'fetch', 'rebase', or
+	'dcommit' operations), look for the first `From:` or `Signed-off-by:` line
 	in the log message and use that as the author string.
---add-author-from::
 	When committing to svn from git (as part of commit or dcommit
+--add-author-from::
+	When committing to svn from git (as part of 'commit' or 'dcommit'
 	operations), if the existing log message doesn't already have a
-	From: or Signed-off-by: line, append a From: line based on the
-	git commit's author string.  If you use this, then --use-log-author
+	`From:` or `Signed-off-by:` line, append a `From:` line based on the
+	git commit's author string.  If you use this, then `--use-log-author`
 	will retrieve a valid author string for all commits.

-- 
1.7.1

Eric Wong· Apr 25, 2011, 21:06 UTC · re: Valentin Haenel · lore

Re: [PATCH 0/2] Documentation fixes for git-svn.txt

Valentin Haenel <valentin.haenel@gmx.de> wrote:

Show 8 quoted lines

> My remaining question regarding the second option, '--add-author-from',
> is about the subcommands which it is applicable to. The current
> documentation states 'commit' and 'dcommit'. My feeling is that 'commit'
> is a typo, since 'git svn' does not have a 'commit' subcommand. I had a
> look at the code, and while I am not familiar with perl, it seems to me
> that the three subcommands that use the option are 'commit-diff',
> 'set-tree' and 'dcommit'. But this is non-trivial -- feedback is
> appreciated.

Yes, commit-diff, set-tree, and dcommit all use --add-author-from.

I don't have time to build the docs and test formatting, but your changes all look reasonable, consider them:

Acked-by: Eric Wong <normalperson@yhbt.net>

Thanks!

-- 
Eric Wong

Valentin Haenel· Apr 25, 2011, 21:36 UTC · re: Eric Wong · lore

[PATCH] git-svn.txt: fix usage of --add-author-from

The option '--add-author-from' is used in 'commit-diff', 'set-tree', and 'dcommit'

Signed-off-by: Valentin Haenel <valentin.haenel@gmx.de>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
 Documentation/git-svn.txt |    2 +-
 1 files changed, 1 insertions(+), 1 deletions(-)

Show changes to Documentation/git-svn.txt +1 −1

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 5c75d71..4865007 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -567,7 +567,7 @@ creating the branch or tag.
 	in the log message and use that as the author string.
 	When committing to svn from git (as part of commit or dcommit
 --add-author-from::
-	When committing to svn from git (as part of 'commit' or 'dcommit'
+	When committing to svn from git (as part of 'commit-diff', 'set-tree' or 'dcommit'
 	operations), if the existing log message doesn't already have a
 	`From:` or `Signed-off-by:` line, append a `From:` line based on the
 	git commit's author string.  If you use this, then `--use-log-author`

-- 
1.7.1

Junio C Hamano· Apr 25, 2011, 21:58 UTC · re: Valentin Haenel · lore

Re: [PATCH] git-svn.txt: fix usage of --add-author-from

Thanks for a resend. Very much appreciated.

Valentin Haenel· Apr 26, 2011, 11:34 UTC · re: Eric Wong · lore

[PATCHv2 0/2] Documentation fixes for git-svn.txt

Two patches I failed to resend. Now Rebased against current pu and added Acked-by line.

Valentin Haenel (2):
  git-svn.txt: move option descriptions
  git-svn.txt: small typeface improvements

 Documentation/git-svn.txt |   22 +++++++++++-----------
 1 files changed, 11 insertions(+), 11 deletions(-)

Valentin Haenel· Apr 26, 2011, 11:34 UTC · re: Eric Wong · lore

[PATCHv2 1/2] git-svn.txt: move option descriptions

The options '---use-log-author' and '--add-author-from' are applicable to other subcommands except 'fetch' -- therefore move them from the 'fetch' section to the more general 'options' section

Signed-off-by: Valentin Haenel <valentin.haenel@gmx.de>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
 Documentation/git-svn.txt |   22 +++++++++++-----------
 1 files changed, 11 insertions(+), 11 deletions(-)

Show changes to Documentation/git-svn.txt +11 −9

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index c07b2ad..ba8a95e 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -145,17 +145,6 @@ Skip "branches" and "tags" of first level directories;;
 ------------------------------------------------------------------------
 --
 
---use-log-author;;
-	When retrieving svn commits into git (as part of fetch, rebase, or
-	dcommit operations), look for the first From: or Signed-off-by: line
-	in the log message and use that as the author string.
---add-author-from;;
-	When committing to svn from git (as part of 'commit-diff', 'set-tree' or 'dcommit'
-	operations), if the existing log message doesn't already have a
-	From: or Signed-off-by: line, append a From: line based on the
-	git commit's author string.  If you use this, then --use-log-author
-	will retrieve a valid author string for all commits.
-
 'clone'::
 	Runs 'init' and 'fetch'.  It will automatically create a
 	directory based on the basename of the URL passed to it;
@@ -574,6 +563,17 @@ repository that will be fetched from.
 For 'branch' and 'tag', display the urls that will be used for copying when
 creating the branch or tag.
 
+--use-log-author::
+	When retrieving svn commits into git (as part of fetch, rebase, or
+	dcommit operations), look for the first From: or Signed-off-by: line
+	in the log message and use that as the author string.
+--add-author-from::
+	When committing to svn from git (as part of 'commit-diff', 'set-tree' or 'dcommit'
+	operations), if the existing log message doesn't already have a
+	From: or Signed-off-by: line, append a From: line based on the
+	git commit's author string.  If you use this, then --use-log-author
+	will retrieve a valid author string for all commits.
+
 
 ADVANCED OPTIONS
 ----------------

-- 
1.7.1

Valentin Haenel· Apr 26, 2011, 11:34 UTC · re: Eric Wong · lore

[PATCHv2 2/2] git-svn.txt: small typeface improvements

Signed-off-by: Valentin Haenel <valentin.haenel@gmx.de>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
 Documentation/git-svn.txt |    8 ++++----
 1 files changed, 4 insertions(+), 4 deletions(-)

Show changes to Documentation/git-svn.txt +4 −4

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index ba8a95e..713e523 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -564,14 +564,14 @@ For 'branch' and 'tag', display the urls that will be used for copying when
 creating the branch or tag.
 
 --use-log-author::
-	When retrieving svn commits into git (as part of fetch, rebase, or
-	dcommit operations), look for the first From: or Signed-off-by: line
+	When retrieving svn commits into git (as part of 'fetch', 'rebase', or
+	'dcommit' operations), look for the first `From:` or `Signed-off-by:` line
 	in the log message and use that as the author string.
 --add-author-from::
 	When committing to svn from git (as part of 'commit-diff', 'set-tree' or 'dcommit'
 	operations), if the existing log message doesn't already have a
-	From: or Signed-off-by: line, append a From: line based on the
-	git commit's author string.  If you use this, then --use-log-author
+	`From:` or `Signed-off-by:` line, append a `From:` line based on the
+	git commit's author string.  If you use this, then `--use-log-author`
 	will retrieve a valid author string for all commits.

-- 
1.7.1