contrib/git-svn: better documenting of CLI switches
Also, fix a asciidoc formatting error Signed-off-by: Eric Wong <normalperson@yhbt.net> Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
parent
6f0783cf94
commit
448c81b495
@ -60,16 +60,7 @@ for (my $i = 0; $i < @ARGV; $i++) {
|
|||||||
}
|
}
|
||||||
};
|
};
|
||||||
|
|
||||||
# we may be called as git-svn-(command), or git-svn(command).
|
my %opts = %{$cmd{$cmd}->[2]} if (defined $cmd);
|
||||||
foreach (keys %cmd) {
|
|
||||||
if (/git\-svn\-?($_)(?:\.\w+)?$/) {
|
|
||||||
$cmd = $1;
|
|
||||||
last;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
my %opts;
|
|
||||||
%opts = %{$cmd{$cmd}->[2]} if (defined $cmd);
|
|
||||||
|
|
||||||
GetOptions(%opts, 'help|H|h' => \$_help,
|
GetOptions(%opts, 'help|H|h' => \$_help,
|
||||||
'version|V' => \$_version,
|
'version|V' => \$_version,
|
||||||
@ -97,15 +88,25 @@ sub usage {
|
|||||||
print $fd <<"";
|
print $fd <<"";
|
||||||
git-svn - bidirectional operations between a single Subversion tree and git
|
git-svn - bidirectional operations between a single Subversion tree and git
|
||||||
Usage: $0 <command> [options] [arguments]\n
|
Usage: $0 <command> [options] [arguments]\n
|
||||||
Available commands:
|
|
||||||
|
print $fd "Available commands:\n" unless $cmd;
|
||||||
|
|
||||||
foreach (sort keys %cmd) {
|
foreach (sort keys %cmd) {
|
||||||
|
next if $cmd && $cmd ne $_;
|
||||||
print $fd ' ',pack('A13',$_),$cmd{$_}->[1],"\n";
|
print $fd ' ',pack('A13',$_),$cmd{$_}->[1],"\n";
|
||||||
|
foreach (keys %{$cmd{$_}->[2]}) {
|
||||||
|
# prints out arguments as they should be passed:
|
||||||
|
my $x = s#=s$## ? '<arg>' : s#=i$## ? '<num>' : '';
|
||||||
|
print $fd ' ' x 17, join(', ', map { length $_ > 1 ?
|
||||||
|
"--$_" : "-$_" }
|
||||||
|
split /\|/,$_)," $x\n";
|
||||||
|
}
|
||||||
}
|
}
|
||||||
print $fd <<"";
|
print $fd <<"";
|
||||||
\nGIT_SVN_ID may be set in the environment to an arbitrary identifier if
|
\nGIT_SVN_ID may be set in the environment or via the --id/-i switch to an
|
||||||
you're tracking multiple SVN branches/repositories in one git repository
|
arbitrary identifier if you're tracking multiple SVN branches/repositories in
|
||||||
and want to keep them separate. See git-svn(1) for more information.
|
one git repository and want to keep them separate. See git-svn(1) for more
|
||||||
|
information.
|
||||||
|
|
||||||
exit $exit;
|
exit $exit;
|
||||||
}
|
}
|
||||||
|
@ -116,6 +116,8 @@ OPTIONS
|
|||||||
They are both passed directly to git-diff-tree see
|
They are both passed directly to git-diff-tree see
|
||||||
git-diff-tree(1) for more information.
|
git-diff-tree(1) for more information.
|
||||||
|
|
||||||
|
ADVANCED OPTIONS
|
||||||
|
----------------
|
||||||
-b<refname>::
|
-b<refname>::
|
||||||
--branch <refname>::
|
--branch <refname>::
|
||||||
Used with 'fetch' or 'commit'.
|
Used with 'fetch' or 'commit'.
|
||||||
@ -131,8 +133,21 @@ OPTIONS
|
|||||||
This option may be specified multiple times, once for each
|
This option may be specified multiple times, once for each
|
||||||
branch.
|
branch.
|
||||||
|
|
||||||
|
-i<GIT_SVN_ID>::
|
||||||
|
--id <GIT_SVN_ID>::
|
||||||
|
This sets GIT_SVN_ID (instead of using the environment). See
|
||||||
|
the section on "Tracking Multiple Repositories or Branches" for
|
||||||
|
more information on using GIT_SVN_ID.
|
||||||
|
|
||||||
COMPATIBILITY OPTIONS
|
COMPATIBILITY OPTIONS
|
||||||
---------------------
|
---------------------
|
||||||
|
--upgrade::
|
||||||
|
Only used with the 'rebuild' command.
|
||||||
|
|
||||||
|
Run this if you used an old version of git-svn that used
|
||||||
|
'git-svn-HEAD' instead of 'remotes/git-svn' as the branch
|
||||||
|
for tracking the remote.
|
||||||
|
|
||||||
--no-ignore-externals::
|
--no-ignore-externals::
|
||||||
Only used with the 'fetch' and 'rebuild' command.
|
Only used with the 'fetch' and 'rebuild' command.
|
||||||
|
|
||||||
@ -177,7 +192,7 @@ Tracking and contributing to an Subversion managed-project:
|
|||||||
git-svn commit remotes/git-svn..my-branch
|
git-svn commit remotes/git-svn..my-branch
|
||||||
# Something is committed to SVN, pull the latest into your branch::
|
# Something is committed to SVN, pull the latest into your branch::
|
||||||
git-svn fetch && git pull . remotes/git-svn
|
git-svn fetch && git pull . remotes/git-svn
|
||||||
# Append svn:ignore settings to the default git exclude file:
|
# Append svn:ignore settings to the default git exclude file::
|
||||||
git-svn show-ignore >> .git/info/exclude
|
git-svn show-ignore >> .git/info/exclude
|
||||||
|
|
||||||
DESIGN PHILOSOPHY
|
DESIGN PHILOSOPHY
|
||||||
|
Loading…
Reference in New Issue
Block a user