# [PATCH 0/2] Documentation fixes for git-svn.txt 9 messages from 2011-04-22 to 2011-04-26. Participants: Valentin Haenel, Eric Wong, Junio C Hamano. Thread: https://gitlist.dev/t/27161 ## Valentin Haenel, 2011-04-22 17:03 Subject: [PATCH 0/2] Documentation fixes for git-svn.txt Message-ID: <1303491819-9850-1-git-send-email-valentin.haenel@gmx.de> URL: https://gitlist.dev/e/1303491819-9850-1-git-send-email-valentin.haenel%40gmx.de ``` 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, 2011-04-22 17:03 Subject: [PATCH 1/2] git-svn.txt: move option descriptions Message-ID: <1303491819-9850-2-git-send-email-valentin.haenel@gmx.de> URL: https://gitlist.dev/e/1303491819-9850-2-git-send-email-valentin.haenel%40gmx.de In-Reply-To: <1303491819-9850-1-git-send-email-valentin.haenel@gmx.de> ``` 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 --- Documentation/git-svn.txt | 22 +++++++++++----------- 1 files changed, 11 insertions(+), 11 deletions(-) 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, 2011-04-22 17:03 Subject: [PATCH 2/2] git-svn.txt: small typeface improvements Message-ID: <1303491819-9850-3-git-send-email-valentin.haenel@gmx.de> URL: https://gitlist.dev/e/1303491819-9850-3-git-send-email-valentin.haenel%40gmx.de In-Reply-To: <1303491819-9850-1-git-send-email-valentin.haenel@gmx.de> ``` Signed-off-by: Valentin Haenel --- Documentation/git-svn.txt | 11 ++++++----- 1 files changed, 6 insertions(+), 5 deletions(-) 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, 2011-04-25 21:06 Subject: Re: [PATCH 0/2] Documentation fixes for git-svn.txt Message-ID: <20110425210623.GB13953@dcvr.yhbt.net> URL: https://gitlist.dev/e/20110425210623.GB13953%40dcvr.yhbt.net In-Reply-To: <1303491819-9850-1-git-send-email-valentin.haenel@gmx.de> ``` Valentin Haenel wrote: > 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 Thanks! -- Eric Wong ``` ## Valentin Haenel, 2011-04-25 21:36 Subject: [PATCH] git-svn.txt: fix usage of --add-author-from Message-ID: <1303767375-14887-1-git-send-email-valentin.haenel@gmx.de> URL: https://gitlist.dev/e/1303767375-14887-1-git-send-email-valentin.haenel%40gmx.de In-Reply-To: <20110425210623.GB13953@dcvr.yhbt.net> ``` The option '--add-author-from' is used in 'commit-diff', 'set-tree', and 'dcommit' Signed-off-by: Valentin Haenel Acked-by: Eric Wong --- Documentation/git-svn.txt | 2 +- 1 files changed, 1 insertions(+), 1 deletions(-) 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, 2011-04-25 21:58 Subject: Re: [PATCH] git-svn.txt: fix usage of --add-author-from Message-ID: <7vfwp6hu3b.fsf@alter.siamese.dyndns.org> URL: https://gitlist.dev/e/7vfwp6hu3b.fsf%40alter.siamese.dyndns.org In-Reply-To: <1303767375-14887-1-git-send-email-valentin.haenel@gmx.de> ``` Thanks for a resend. Very much appreciated. ``` ## Valentin Haenel, 2011-04-26 11:34 Subject: [PATCHv2 0/2] Documentation fixes for git-svn.txt Message-ID: <1303817659-26541-1-git-send-email-valentin.haenel@gmx.de> URL: https://gitlist.dev/e/1303817659-26541-1-git-send-email-valentin.haenel%40gmx.de In-Reply-To: <20110425210623.GB13953@dcvr.yhbt.net> ``` 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, 2011-04-26 11:34 Subject: [PATCHv2 1/2] git-svn.txt: move option descriptions Message-ID: <1303817659-26541-2-git-send-email-valentin.haenel@gmx.de> URL: https://gitlist.dev/e/1303817659-26541-2-git-send-email-valentin.haenel%40gmx.de In-Reply-To: <20110425210623.GB13953@dcvr.yhbt.net> ``` 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 Acked-by: Eric Wong --- Documentation/git-svn.txt | 22 +++++++++++----------- 1 files changed, 11 insertions(+), 11 deletions(-) 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, 2011-04-26 11:34 Subject: [PATCHv2 2/2] git-svn.txt: small typeface improvements Message-ID: <1303817659-26541-3-git-send-email-valentin.haenel@gmx.de> URL: https://gitlist.dev/e/1303817659-26541-3-git-send-email-valentin.haenel%40gmx.de In-Reply-To: <20110425210623.GB13953@dcvr.yhbt.net> ``` Signed-off-by: Valentin Haenel Acked-by: Eric Wong --- Documentation/git-svn.txt | 8 ++++---- 1 files changed, 4 insertions(+), 4 deletions(-) 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 ```