@matheusbsbs / matheus-bagliano / commits / 81c5a0e6e5
Fork 0

git-svn: documentation updates

* Clarify that 'init' requires an argument * Remove instances of 'SVN_URL' in the manpage, it's not an environment variable. * Refer to 'Additional Fetch Arguments' when documenting 'fetch' * document --authors-file / -A option Thanks to Pavel Roskin and Seth Falcon for bringing these issues to my attention. Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>

Eric Wong committed May 5, 2006 at 12:35 UTC 81c5a0e6e5135384a7316b9689a5b0baaf1a2752
2 files changed +38 -13
contrib/git-svn/git-svn.perl
+4 -2
@@ -42,7 +42,8 @@ my %fc_opts = ( 'no-ignore-externals' => \$_no_ignore_ext,
42 my %cmd = (
43 fetch => [ \&fetch, "Download new revisions from SVN",
44 { 'revision|r=s' => \$_revision, %fc_opts } ],
45 - init => [ \&init, "Initialize and fetch (import)", { } ],
45 + init => [ \&init, "Initialize a repo for tracking" .
46 + " (requires URL argument)", { } ],
47 commit => [ \&commit, "Commit git revisions to SVN",
48 { 'stdin|' => \$_stdin,
49 'edit|e' => \$_edit,
@@ -220,7 +221,8 @@ when you have upgraded your tools and habits to use refs/remotes/$GIT_SVN
221 }
222
223 sub init {
223 - $SVN_URL = shift or croak "SVN repository location required\n";
224 + $SVN_URL = shift or die "SVN repository location required " .
225 + "as a command-line argument\n";
226 unless (-d $GIT_DIR) {
227 sys('git-init-db');
228 }
contrib/git-svn/git-svn.txt
+34 -11
@@ -36,17 +36,22 @@ COMMANDS
36 --------
37 init::
38 Creates an empty git repository with additional metadata
39 - directories for git-svn. The SVN_URL must be specified
40 - at this point.
39 + directories for git-svn. The Subversion URL must be specified
40 + as a command-line argument.
41
42 fetch::
43 - Fetch unfetched revisions from the SVN_URL we are tracking.
44 - refs/heads/remotes/git-svn will be updated to the latest revision.
43 + Fetch unfetched revisions from the Subversion URL we are
44 + tracking. refs/remotes/git-svn will be updated to the
45 + latest revision.
46
46 - Note: You should never attempt to modify the remotes/git-svn branch
47 - outside of git-svn. Instead, create a branch from remotes/git-svn
48 - and work on that branch. Use the 'commit' command (see below)
49 - to write git commits back to remotes/git-svn.
47 + Note: You should never attempt to modify the remotes/git-svn
48 + branch outside of git-svn. Instead, create a branch from
49 + remotes/git-svn and work on that branch. Use the 'commit'
50 + command (see below) to write git commits back to
51 + remotes/git-svn.
52 +
53 + See 'Additional Fetch Arguments' if you are interested in
54 + manually joining branches on commit.
55
56 commit::
57 Commit specified commit or tree objects to SVN. This relies on
@@ -62,9 +67,9 @@ rebuild::
67 tracked with git-svn. Unfortunately, git-clone does not clone
68 git-svn metadata and the svn working tree that git-svn uses for
69 its operations. This rebuilds the metadata so git-svn can
65 - resume fetch operations. SVN_URL may be optionally specified if
66 - the directory/repository you're tracking has moved or changed
67 - protocols.
70 + resume fetch operations. A Subversion URL may be optionally
71 + specified at the command-line if the directory/repository you're
72 + tracking has moved or changed protocols.
73
74 show-ignore::
75 Recursively finds and lists the svn:ignore property on
@@ -123,6 +128,24 @@ OPTIONS
128 repo-config key: svn.l
129 repo-config key: svn.findcopiesharder
130
131 +-A<filename>::
132 +--authors-file=<filename>::
133 +
134 + Syntax is compatible with the files used by git-svnimport and
135 + git-cvsimport:
136 +
137 +------------------------------------------------------------------------
138 +loginname = Joe User <user@example.com>
139 +------------------------------------------------------------------------
140 +
141 + If this option is specified and git-svn encounters an SVN
142 + committer name that does not exist in the authors-file, git-svn
143 + will abort operation. The user will then have to add the
144 + appropriate entry. Re-running the previous git-svn command
145 + after the authors-file is modified should continue operation.
146 +
147 + repo-config key: svn.authors-file
148 +
149 ADVANCED OPTIONS
150 ----------------
151 -b<refname>::