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>maint
parent
ac4c758adc
commit
81c5a0e6e5
|
@ -42,7 +42,8 @@ my %fc_opts = ( 'no-ignore-externals' => \$_no_ignore_ext,
|
||||||
my %cmd = (
|
my %cmd = (
|
||||||
fetch => [ \&fetch, "Download new revisions from SVN",
|
fetch => [ \&fetch, "Download new revisions from SVN",
|
||||||
{ 'revision|r=s' => \$_revision, %fc_opts } ],
|
{ 'revision|r=s' => \$_revision, %fc_opts } ],
|
||||||
init => [ \&init, "Initialize and fetch (import)", { } ],
|
init => [ \&init, "Initialize a repo for tracking" .
|
||||||
|
" (requires URL argument)", { } ],
|
||||||
commit => [ \&commit, "Commit git revisions to SVN",
|
commit => [ \&commit, "Commit git revisions to SVN",
|
||||||
{ 'stdin|' => \$_stdin,
|
{ 'stdin|' => \$_stdin,
|
||||||
'edit|e' => \$_edit,
|
'edit|e' => \$_edit,
|
||||||
|
@ -220,7 +221,8 @@ when you have upgraded your tools and habits to use refs/remotes/$GIT_SVN
|
||||||
}
|
}
|
||||||
|
|
||||||
sub init {
|
sub init {
|
||||||
$SVN_URL = shift or croak "SVN repository location required\n";
|
$SVN_URL = shift or die "SVN repository location required " .
|
||||||
|
"as a command-line argument\n";
|
||||||
unless (-d $GIT_DIR) {
|
unless (-d $GIT_DIR) {
|
||||||
sys('git-init-db');
|
sys('git-init-db');
|
||||||
}
|
}
|
||||||
|
|
|
@ -36,17 +36,22 @@ COMMANDS
|
||||||
--------
|
--------
|
||||||
init::
|
init::
|
||||||
Creates an empty git repository with additional metadata
|
Creates an empty git repository with additional metadata
|
||||||
directories for git-svn. The SVN_URL must be specified
|
directories for git-svn. The Subversion URL must be specified
|
||||||
at this point.
|
as a command-line argument.
|
||||||
|
|
||||||
fetch::
|
fetch::
|
||||||
Fetch unfetched revisions from the SVN_URL we are tracking.
|
Fetch unfetched revisions from the Subversion URL we are
|
||||||
refs/heads/remotes/git-svn will be updated to the latest revision.
|
tracking. refs/remotes/git-svn will be updated to the
|
||||||
|
latest revision.
|
||||||
|
|
||||||
Note: You should never attempt to modify the remotes/git-svn branch
|
Note: You should never attempt to modify the remotes/git-svn
|
||||||
outside of git-svn. Instead, create a branch from remotes/git-svn
|
branch outside of git-svn. Instead, create a branch from
|
||||||
and work on that branch. Use the 'commit' command (see below)
|
remotes/git-svn and work on that branch. Use the 'commit'
|
||||||
to write git commits back to remotes/git-svn.
|
command (see below) to write git commits back to
|
||||||
|
remotes/git-svn.
|
||||||
|
|
||||||
|
See 'Additional Fetch Arguments' if you are interested in
|
||||||
|
manually joining branches on commit.
|
||||||
|
|
||||||
commit::
|
commit::
|
||||||
Commit specified commit or tree objects to SVN. This relies on
|
Commit specified commit or tree objects to SVN. This relies on
|
||||||
|
@ -62,9 +67,9 @@ rebuild::
|
||||||
tracked with git-svn. Unfortunately, git-clone does not clone
|
tracked with git-svn. Unfortunately, git-clone does not clone
|
||||||
git-svn metadata and the svn working tree that git-svn uses for
|
git-svn metadata and the svn working tree that git-svn uses for
|
||||||
its operations. This rebuilds the metadata so git-svn can
|
its operations. This rebuilds the metadata so git-svn can
|
||||||
resume fetch operations. SVN_URL may be optionally specified if
|
resume fetch operations. A Subversion URL may be optionally
|
||||||
the directory/repository you're tracking has moved or changed
|
specified at the command-line if the directory/repository you're
|
||||||
protocols.
|
tracking has moved or changed protocols.
|
||||||
|
|
||||||
show-ignore::
|
show-ignore::
|
||||||
Recursively finds and lists the svn:ignore property on
|
Recursively finds and lists the svn:ignore property on
|
||||||
|
@ -123,6 +128,24 @@ OPTIONS
|
||||||
repo-config key: svn.l
|
repo-config key: svn.l
|
||||||
repo-config key: svn.findcopiesharder
|
repo-config key: svn.findcopiesharder
|
||||||
|
|
||||||
|
-A<filename>::
|
||||||
|
--authors-file=<filename>::
|
||||||
|
|
||||||
|
Syntax is compatible with the files used by git-svnimport and
|
||||||
|
git-cvsimport:
|
||||||
|
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
loginname = Joe User <user@example.com>
|
||||||
|
------------------------------------------------------------------------
|
||||||
|
|
||||||
|
If this option is specified and git-svn encounters an SVN
|
||||||
|
committer name that does not exist in the authors-file, git-svn
|
||||||
|
will abort operation. The user will then have to add the
|
||||||
|
appropriate entry. Re-running the previous git-svn command
|
||||||
|
after the authors-file is modified should continue operation.
|
||||||
|
|
||||||
|
repo-config key: svn.authors-file
|
||||||
|
|
||||||
ADVANCED OPTIONS
|
ADVANCED OPTIONS
|
||||||
----------------
|
----------------
|
||||||
-b<refname>::
|
-b<refname>::
|
||||||
|
|
Loading…
Reference in New Issue