Re: [PATCH] git-svn.txt: mention how to rebuild rev_map files

2013-09-25 Thread Jonathan Nieder
Hi,

Keshav Kini wrote:

 The man page for `git svn` describes a situation in which 'git svn'
 will not be able to rebuild your .git/svn/**/.rev_map files, but no
 mention is made of in what circumstances `git svn` *will* be able to do
 so, or how to get `git svn` to do so.

 This patch adds some language to the description of the 'fetch' command
 to rectify this oversight, and also fixes an AsciiDoc escaping typo.

 Signed-off-by: Keshav Kini keshav.k...@gmail.com

Good idea.

[...]
 --- a/Documentation/git-svn.txt
 +++ b/Documentation/git-svn.txt
 @@ -103,9 +103,12 @@ COMMANDS
  
  'fetch'::
   Fetch unfetched revisions from the Subversion remote we are
 - tracking.  The name of the [svn-remote ...] section in the
 - .git/config file may be specified as an optional command-line
 - argument.
 + tracking.  If necessary, rebuild the .git/svn/\*\*/.rev_map.*
 + files, given the requisite information exists in commit
 + messages (see the svn.noMetadata config option for more
 + information).  The name of the [svn-remote ...] section in
 + the .git/config file may be specified as an optional
 + command-line argument.

Taking a step back, the reader might wonder *why* he would want
to run git svn fetch to rebuilt these .rev_map.* files, and what
they are for.

Perhaps there should be a separate REVISION MAP section describing
this in more detail.  Something as simple as

FILES
-
.git/svn/\*\*/.rev_map.\*::
Mapping between Subversion revision numbers and Git
commit names.  Can be rebuilt using the git-svn-id:
lines at the end of every commit as long as the
noMetadata option is not set (see the 'svn.noMetadata'
section above for details).
+
'git svn fetch' and 'git svn rebase' automatically update
the rev_map if it is missing or not up to date.  'git svn
reset' automatically rewinds it.

Then this reference in 'fetch' could just say something like

...
argument.
+
 This automatically updates the rev_map if needed (see
 '.git/svn/\*\*/.rev_map.\*' in the FILES section below for
 details).

 @@ -684,7 +687,7 @@ svn-remote.name.noMetadata::
  +
  This option can only be used for one-shot imports as 'git svn'
  will not be able to fetch again without metadata. Additionally,
 -if you lose your .git/svn/**/.rev_map.* files, 'git svn' will not
 +if you lose your .git/svn/\*\*/.rev_map.* files, 'git svn' will not

I don't mind seeing this fix snuck into the same commit, but a
separate commit that could be applied more quickly would be even
better. ;-)

Thanks and hope that helps,
Jonathan
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] git-svn.txt: mention how to rebuild rev_map files

2013-09-25 Thread Eric Wong
Jonathan Nieder jrnie...@gmail.com wrote:
 Keshav Kini wrote:
  +   tracking.  If necessary, rebuild the .git/svn/\*\*/.rev_map.*
  +   files, given the requisite information exists in commit
  +   messages (see the svn.noMetadata config option for more
  +   information).  The name of the [svn-remote ...] section in
  +   the .git/config file may be specified as an optional
  +   command-line argument.
 
 Taking a step back, the reader might wonder *why* he would want
 to run git svn fetch to rebuilt these .rev_map.* files, and what
 they are for.
 
 Perhaps there should be a separate REVISION MAP section describing
 this in more detail.  Something as simple as

I agree with Jonathan's suggestions.

Keshav: can you please resend with Jonathan's suggestions?
Thanks both.
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] git-svn.txt: mention how to rebuild rev_map files

2013-09-25 Thread Keshav Kini
Jonathan Nieder jrnie...@gmail.com writes:
 Taking a step back, the reader might wonder *why* he would want
 to run git svn fetch to rebuilt these .rev_map.* files, and what
 they are for.

 Perhaps there should be a separate REVISION MAP section describing
 this in more detail.  Something as simple as

   FILES
   -
   .git/svn/\*\*/.rev_map.\*::
   Mapping between Subversion revision numbers and Git
   commit names.  Can be rebuilt using the git-svn-id:
   lines at the end of every commit as long as the
   noMetadata option is not set (see the 'svn.noMetadata'
   section above for details).
   +
   'git svn fetch' and 'git svn rebase' automatically update
   the rev_map if it is missing or not up to date.  'git svn
   reset' automatically rewinds it.

 Then this reference in 'fetch' could just say something like

   ...
   argument.
   +
  This automatically updates the rev_map if needed (see
  '.git/svn/\*\*/.rev_map.\*' in the FILES section below for
  details).

Note that only the first two asterisks are escaped in my patch. For some
reason, escaping all three causes a literal '\' to appear in asciidoc's
output...

I changed the wording of your first paragraph a bit according to what I
thought it meant. Does it still convey what you wanted to convey, and is
it still correct?

Mapping between Subversion revision numbers and Git commit
names.  In a repository where the noMetadata option is not set,
this can be rebuilt from the git-svn-id: lines that are at the
end of every commit (see the 'svn.noMetadata' section above for
details).

Also, I'm having a bit of trouble trying to get a definition to start
with a '.' character in AsciiDoc.  Escaping the '.' produces a
definition block, but with a literal '\' before the '.'.  If I don't
escape the '.', asciidoc thinks it's a section heading or something. Is
asciidoc just incapable of doing this, or am I missing something?

-Keshav

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] git-svn.txt: mention how to rebuild rev_map files

2013-09-25 Thread Jonathan Nieder
Keshav Kini wrote:

 I changed the wording of your first paragraph a bit according to what I
 thought it meant. Does it still convey what you wanted to convey, and is
 it still correct?

 Mapping between Subversion revision numbers and Git commit
 names.  In a repository where the noMetadata option is not set,
 this can be rebuilt from the git-svn-id: lines that are at the
 end of every commit (see the 'svn.noMetadata' section above for
 details).

Sounds good.

 Also, I'm having a bit of trouble trying to get a definition to start
 with a '.' character in AsciiDoc.  Escaping the '.' produces a
 definition block, but with a literal '\' before the '.'.  If I don't
 escape the '.', asciidoc thinks it's a section heading or something. Is
 asciidoc just incapable of doing this, or am I missing something?

Oh.  Yeah, this can be a pain.  Quoting the filename with `backticks`
might work.  Writing $GIT_DIR instead of .git might be simpler (see
v1.5.3.2~18 Documentation/git-config.txt: AsciiDoc tweak to avoid
leading dot, 2007-09-14).

Thanks,
Jonathan
--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] git-svn.txt: mention how to rebuild rev_map files

2013-09-25 Thread Keshav Kini
Jonathan Nieder jrnie...@gmail.com writes:
 Keshav Kini wrote:

 I changed the wording of your first paragraph a bit according to what I
 thought it meant. Does it still convey what you wanted to convey, and is
 it still correct?

 Mapping between Subversion revision numbers and Git commit
 names.  In a repository where the noMetadata option is not set,
 this can be rebuilt from the git-svn-id: lines that are at the
 end of every commit (see the 'svn.noMetadata' section above for
 details).

 Sounds good.

 Also, I'm having a bit of trouble trying to get a definition to start
 with a '.' character in AsciiDoc.  Escaping the '.' produces a
 definition block, but with a literal '\' before the '.'.  If I don't
 escape the '.', asciidoc thinks it's a section heading or something. Is
 asciidoc just incapable of doing this, or am I missing something?

 Oh.  Yeah, this can be a pain.  Quoting the filename with `backticks`
 might work.  Writing $GIT_DIR instead of .git might be simpler (see
 v1.5.3.2~18 Documentation/git-config.txt: AsciiDoc tweak to avoid
 leading dot, 2007-09-14).

Good point.  Actually it seems to me that writing $GIT_DIR is in fact
more correct, since $GIT_DIR need not be .git at all.  So I'll just
use that.  Reroll coming up in a bit.

-Keshav

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


Re: [PATCH] git-svn.txt: mention how to rebuild rev_map files

2013-09-25 Thread Keshav Kini
Jonathan Nieder jrnie...@gmail.com writes:
 @@ -684,7 +687,7 @@ svn-remote.name.noMetadata::
  +
  This option can only be used for one-shot imports as 'git svn'
  will not be able to fetch again without metadata. Additionally,
 -if you lose your .git/svn/**/.rev_map.* files, 'git svn' will not
 +if you lose your .git/svn/\*\*/.rev_map.* files, 'git svn' will not

 I don't mind seeing this fix snuck into the same commit, but a
 separate commit that could be applied more quickly would be even
 better. ;-)

May I also roll into said commit a couple of replacements of .git with
$GIT_DIR in the same file, or other such minor touchups?

-Keshav

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[PATCH] git-svn.txt: mention how to rebuild rev_map files

2013-09-23 Thread Keshav Kini
The man page for `git svn` describes a situation in which 'git svn'
will not be able to rebuild your .git/svn/**/.rev_map files, but no
mention is made of in what circumstances `git svn` *will* be able to do
so, or how to get `git svn` to do so.

This patch adds some language to the description of the 'fetch' command
to rectify this oversight, and also fixes an AsciiDoc escaping typo.

Signed-off-by: Keshav Kini keshav.k...@gmail.com
---
 Documentation/git-svn.txt | 11 +++
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 4dd3bcb..040117a 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -103,9 +103,12 @@ COMMANDS
 
 'fetch'::
Fetch unfetched revisions from the Subversion remote we are
-   tracking.  The name of the [svn-remote ...] section in the
-   .git/config file may be specified as an optional command-line
-   argument.
+   tracking.  If necessary, rebuild the .git/svn/\*\*/.rev_map.*
+   files, given the requisite information exists in commit
+   messages (see the svn.noMetadata config option for more
+   information).  The name of the [svn-remote ...] section in
+   the .git/config file may be specified as an optional
+   command-line argument.
 
 --localtime;;
Store Git commit times in the local timezone instead of UTC.  This
@@ -684,7 +687,7 @@ svn-remote.name.noMetadata::
 +
 This option can only be used for one-shot imports as 'git svn'
 will not be able to fetch again without metadata. Additionally,
-if you lose your .git/svn/**/.rev_map.* files, 'git svn' will not
+if you lose your .git/svn/\*\*/.rev_map.* files, 'git svn' will not
 be able to rebuild them.
 +
 The 'git svn log' command will not work on repositories using
-- 
1.8.3.2

--
To unsubscribe from this list: send the line unsubscribe git in
the body of a message to majord...@vger.kernel.org
More majordomo info at  http://vger.kernel.org/majordomo-info.html