* [PATCH 0/4] First set of improvements to git-svn user doc
@ 2009-07-05 22:03 Yann Dirson
2009-07-05 22:03 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
2009-07-06 22:20 ` [PATCH 0/4] First set of improvements to git-svn user doc Eric Wong
0 siblings, 2 replies; 17+ messages in thread
From: Yann Dirson @ 2009-07-05 22:03 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
>From my previous post, I have splitted the changes to the manpage for easier
review and incremental integration. Here are the parts I consider mature
enough to be proposed into master. The other ones are still WIP and I'll
repost them when I have made real progress on them.
Yann Dirson (4):
git-svn.txt: stop using dash-form of commands.
git-svn.txt: make formatting more consistent.
git-svn.txt: fix fetch flags incorrectly documented as init flags.
git-svn.txt: fix description of fetch flags accepted by clone.
Documentation/git-svn.txt | 337 ++++++++++++++++++++++-----------------------
1 files changed, 164 insertions(+), 173 deletions(-)
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 1/4] git-svn.txt: stop using dash-form of commands.
2009-07-05 22:03 [PATCH 0/4] First set of improvements to git-svn user doc Yann Dirson
@ 2009-07-05 22:03 ` Yann Dirson
2009-07-05 22:03 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
2009-07-06 22:20 ` [PATCH 0/4] First set of improvements to git-svn user doc Eric Wong
1 sibling, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-05 22:03 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Also consistently use single quotes around git commands to make things clear
(was only needed at a couple of places).
Signed-off-by: Yann Dirson <ydirson@altern.org>
---
Documentation/git-svn.txt | 110 ++++++++++++++++++++++----------------------
1 files changed, 55 insertions(+), 55 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 7e9b9a0..a42f96a 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -11,11 +11,11 @@ SYNOPSIS
DESCRIPTION
-----------
-'git-svn' is a simple conduit for changesets between Subversion and git.
+'git svn' is a simple conduit for changesets between Subversion and git.
It provides a bidirectional flow of changes between a Subversion and a git
repository.
-'git-svn' can track a standard Subversion repository,
+'git svn' can track a standard Subversion repository,
following the common "trunk/branches/tags" layout, with the --stdlayout option.
It can also follow branches and tags in any layout with the -T/-t/-b options
(see options to 'init' below, and also the 'clone' command).
@@ -30,7 +30,7 @@ COMMANDS
'init'::
Initializes an empty git repository with additional
- metadata directories for 'git-svn'. The Subversion URL
+ metadata directories for 'git svn'. The Subversion URL
may be specified as a command-line argument, or as full
URL arguments to -T/-t/-b. Optionally, the target
directory to operate on can be specified as a second
@@ -100,7 +100,7 @@ COMMANDS
--localtime;;
Store Git commit times in the local timezone instead of UTC. This
- makes 'git-log' (even without --date=local) show the same times
+ makes 'git log' (even without --date=local) show the same times
that `svn log` would in the local timezone.
--parent;;
@@ -148,20 +148,20 @@ Examples:
This fetches revisions from the SVN parent of the current HEAD
and rebases the current (uncommitted to SVN) work against it.
-This works similarly to `svn update` or 'git-pull' except that
-it preserves linear history with 'git-rebase' instead of
-'git-merge' for ease of dcommitting with 'git-svn'.
+This works similarly to `svn update` or 'git pull' except that
+it preserves linear history with 'git rebase' instead of
+'git merge' for ease of dcommitting with 'git svn'.
-This accepts all options that 'git-svn fetch' and 'git-rebase'
+This accepts all options that 'git svn fetch' and 'git rebase'
accept. However, '--fetch-all' only fetches from the current
[svn-remote], and not all [svn-remote] definitions.
-Like 'git-rebase'; this requires that the working tree be clean
+Like 'git rebase'; this requires that the working tree be clean
and have no uncommitted changes.
-l;;
--local;;
- Do not fetch remotely; only run 'git-rebase' against the
+ Do not fetch remotely; only run 'git rebase' against the
last fetched commit from the upstream SVN.
'dcommit'::
@@ -169,7 +169,7 @@ and have no uncommitted changes.
repository, and then rebase or reset (depending on whether or
not there is a diff between SVN and head). This will create
a revision in SVN for each commit in git.
- It is recommended that you run 'git-svn' fetch and rebase (not
+ It is recommended that you run 'git svn' fetch and rebase (not
pull or merge) your commits against the latest changes in the
SVN repository.
An optional revision or branch argument may be specified, and
@@ -182,7 +182,7 @@ and have no uncommitted changes.
After committing, do not rebase or reset.
--commit-url <URL>;;
Commit to this SVN URL (the full path). This is intended to
- allow existing git-svn repositories created with one transport
+ allow existing 'git svn' repositories created with one transport
method (e.g. `svn://` or `http://` for anonymous read) to be
reused if a user is later given access to an alternate transport
method (e.g. `svn+ssh://` or `https://`) for commit.
@@ -258,7 +258,7 @@ NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
client converts the UTC time to the local time (or based on the TZ=
environment). This command has the same behaviour.
+
-Any other arguments are passed directly to 'git-log'
+Any other arguments are passed directly to 'git log'
'blame'::
Show what revision and author last modified each line of a file. The
@@ -266,10 +266,10 @@ Any other arguments are passed directly to 'git-log'
`svn blame' by default. Like the SVN blame command,
local uncommitted changes in the working copy are ignored;
the version of the file in the HEAD revision is annotated. Unknown
- arguments are passed directly to 'git-blame'.
+ arguments are passed directly to 'git blame'.
+
--git-format;;
- Produce output in the same format as 'git-blame', but with
+ Produce output in the same format as 'git blame', but with
SVN revision numbers instead of git commit hashes. In this mode,
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
@@ -288,7 +288,7 @@ Any other arguments are passed directly to 'git-log'
absolutely no attempts to do patching when committing to SVN, it
simply overwrites files with those specified in the tree or
commit. All merging is assumed to have taken place
- independently of 'git-svn' functions.
+ independently of 'git svn' functions.
'create-ignore'::
Recursively finds the svn:ignore property on directories and
@@ -303,12 +303,12 @@ Any other arguments are passed directly to 'git-log'
'commit-diff'::
Commits the diff of two tree-ish arguments from the
- command-line. This command does not rely on being inside an `git-svn
+ command-line. This command does not rely on being inside an `git svn
init`-ed repository. This command takes three arguments, (a) the
original tree to diff against, (b) the new tree result, (c) the
URL of the target Subversion repository. The final argument
- (URL) may be omitted if you are working from a 'git-svn'-aware
- repository (that has been `init`-ed with 'git-svn').
+ (URL) may be omitted if you are working from a 'git svn'-aware
+ repository (that has been `init`-ed with 'git svn').
The -r<revision> option is required for this.
'info'::
@@ -396,7 +396,7 @@ OPTIONS
--shared[={false|true|umask|group|all|world|everybody}]::
--template=<template_directory>::
Only used with the 'init' command.
- These are passed directly to 'git-init'.
+ These are passed directly to 'git init'.
-r <ARG>::
--revision <ARG>::
@@ -418,7 +418,7 @@ Only used with the 'set-tree' command.
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
-'git-rev-list --pretty=oneline' output can be used.
+'git rev-list --pretty=oneline' output can be used.
--rmdir::
@@ -448,7 +448,7 @@ config key: svn.edit
Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-They are both passed directly to 'git-diff-tree'; see
+They are both passed directly to 'git diff-tree'; see
linkgit:git-diff-tree[1] for more information.
[verse]
@@ -458,16 +458,16 @@ config key: svn.findcopiesharder
-A<filename>::
--authors-file=<filename>::
-Syntax is compatible with the file used by 'git-cvsimport':
+Syntax is compatible with the file used by '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'
+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
+appropriate entry. Re-running the previous 'git svn' command
after the authors-file is modified should continue operation.
config key: svn.authorsfile
@@ -482,7 +482,7 @@ the authors file.
-q::
--quiet::
- Make 'git-svn' less verbose. Specify a second time to make it
+ Make 'git svn' less verbose. Specify a second time to make it
even less verbose.
--repack[=<n>]::
@@ -495,7 +495,7 @@ with many revisions.
to fetch before repacking. This defaults to repacking every
1000 commits fetched if no argument is specified.
---repack-flags are passed directly to 'git-repack'.
+--repack-flags are passed directly to 'git repack'.
[verse]
config key: svn.repack
@@ -508,8 +508,8 @@ config key: svn.repackflags
These are only used with the 'dcommit' and 'rebase' commands.
-Passed directly to 'git-rebase' when using 'dcommit' if a
-'git-reset' cannot be used (see 'dcommit').
+Passed directly to 'git rebase' when using 'dcommit' if a
+'git reset' cannot be used (see 'dcommit').
-n::
--dry-run::
@@ -566,18 +566,18 @@ svn-remote.<name>.noMetadata::
This gets rid of the 'git-svn-id:' lines at the end of every commit.
-If you lose your .git/svn/git-svn/.rev_db file, 'git-svn' will not
+If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not
be able to rebuild it and you won't be able to fetch again,
either. This is fine for one-shot imports.
-The 'git-svn log' command will not work on repositories using
+The 'git svn log' command will not work on repositories using
this, either. Using this conflicts with the 'useSvmProps'
option for (hopefully) obvious reasons.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
-This allows 'git-svn' to re-map repository URLs and UUIDs from
+This allows 'git svn' to re-map repository URLs and UUIDs from
mirrors created using SVN::Mirror (or svk) for metadata.
If an SVN revision has a property, "svm:headrev", it is likely
@@ -596,7 +596,7 @@ svn-remote.<name>.useSvnsyncprops::
svn-remote.<name>.rewriteRoot::
This allows users to create repositories from alternate
- URLs. For example, an administrator could run 'git-svn' on the
+ URLs. For example, an administrator could run 'git svn' on the
server locally (accessing via file://) but wish to distribute
the repository with a public http:// or svn:// URL in the
metadata so users of it will see the public URL.
@@ -605,14 +605,14 @@ svn.brokenSymlinkWorkaround::
This disables potentially expensive checks to workaround broken symlinks
checked into SVN by broken clients. Set this option to "false" if you
track a SVN repository with many empty blobs that are not symlinks.
-This option may be changed while "git-svn" is running and take effect on
-the next revision fetched. If unset, git-svn assumes this option to be
+This option may be changed while 'git svn' is running and take effect on
+the next revision fetched. If unset, 'git svn' assumes this option to be
"true".
--
Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
-options all affect the metadata generated and used by 'git-svn'; they
+options all affect the metadata generated and used by 'git svn'; they
*must* be set in the configuration file before any history is imported
and these settings should never be changed once they are set.
@@ -630,7 +630,7 @@ Tracking and contributing to the trunk of a Subversion-managed project:
git svn clone http://svn.example.com/project/trunk
# Enter the newly cloned directory:
cd trunk
-# You should be on master branch, double-check with git-branch
+# You should be on master branch, double-check with 'git branch'
git branch
# Do some work and commit locally to git:
git commit ...
@@ -661,12 +661,12 @@ Tracking and contributing to an entire Subversion-managed project
# of dcommit/rebase/show-ignore should be the same as above.
------------------------------------------------------------------------
-The initial 'git-svn clone' can be quite time-consuming
+The initial 'git svn clone' can be quite time-consuming
(especially for large Subversion repositories). If multiple
people (or one person with multiple machines) want to use
-'git-svn' to interact with the same Subversion repository, you can
-do the initial 'git-svn clone' to a repository on a server and
-have each person clone that repository with 'git-clone':
+'git svn' to interact with the same Subversion repository, you can
+do the initial 'git svn clone' to a repository on a server and
+have each person clone that repository with 'git clone':
------------------------------------------------------------------------
# Do the initial import on a server
@@ -680,7 +680,7 @@ have each person clone that repository with 'git-clone':
git fetch
# Create a local branch from one of the branches just fetched
git checkout -b master FETCH_HEAD
-# Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server)
+# Initialize 'git svn' locally (be sure to use the same URL and -T/-b/-t options as were used on server)
git svn init http://svn.example.com/project
# Pull the latest changes from Subversion
git svn rebase
@@ -689,7 +689,7 @@ have each person clone that repository with 'git-clone':
REBASE VS. PULL/MERGE
---------------------
-Originally, 'git-svn' recommended that the 'remotes/git-svn' branch be
+Originally, 'git svn' recommended that the 'remotes/git-svn' branch be
pulled or merged from. This is because the author favored
`git svn set-tree B` to commit a single head rather than the
`git svn set-tree A..B` notation to commit multiple commits.
@@ -704,7 +704,7 @@ previous commits in SVN.
DESIGN PHILOSOPHY
-----------------
Merge tracking in Subversion is lacking and doing branched development
-with Subversion can be cumbersome as a result. While 'git-svn' can track
+with Subversion can be cumbersome as a result. While 'git svn' can track
copy history (including branches and tags) for repositories adopting a
standard layout, it cannot yet represent merge history that happened
inside git back upstream to SVN users. Therefore it is advised that
@@ -715,25 +715,25 @@ CAVEATS
-------
For the sake of simplicity and interoperating with a less-capable system
-(SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit
-directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push'
+(SVN), it is recommended that all 'git svn' users clone, fetch and dcommit
+directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
operations between git repositories and branches. The recommended
method of exchanging code between git branches and users is
-'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository.
+'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
-Running 'git-merge' or 'git-pull' is NOT recommended on a branch you
+Running 'git merge' or 'git pull' is NOT recommended on a branch you
plan to 'dcommit' from. Subversion does not represent merges in any
reasonable or useful fashion; so users using Subversion cannot see any
merges you've made. Furthermore, if you merge or pull from a git branch
that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
branch.
-'git-clone' does not clone branches under the refs/remotes/ hierarchy or
-any 'git-svn' metadata, or config. So repositories created and managed with
-using 'git-svn' should use 'rsync' for cloning, if cloning is to be done
+'git clone' does not clone branches under the refs/remotes/ hierarchy or
+any 'git svn' metadata, or config. So repositories created and managed with
+using 'git svn' should use 'rsync' for cloning, if cloning is to be done
at all.
-Since 'dcommit' uses rebase internally, any git branches you 'git-push' to
+Since 'dcommit' uses rebase internally, any git branches you 'git push' to
before 'dcommit' on will require forcing an overwrite of the existing ref
on the remote repository. This is generally considered bad practice,
see the linkgit:git-push[1] documentation for details.
@@ -769,7 +769,7 @@ for git to detect them.
CONFIGURATION
-------------
-'git-svn' stores [svn-remote] configuration information in the
+'git svn' stores [svn-remote] configuration information in the
repository .git/config file. It is similar the core git
[remote] sections except 'fetch' keys do not accept glob
arguments; but they are instead handled by the 'branches'
@@ -790,7 +790,7 @@ Keep in mind that the '\*' (asterisk) wildcard of the local ref
however the remote wildcard may be anywhere as long as it's an
independent path component (surrounded by '/' or EOL). This
type of configuration is not automatically created by 'init' and
-should be manually entered with a text-editor or using 'git-config'.
+should be manually entered with a text-editor or using 'git config'.
SEE ALSO
--------
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 2/4] git-svn.txt: make formatting more consistent.
2009-07-05 22:03 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
@ 2009-07-05 22:03 ` Yann Dirson
2009-07-05 22:03 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-05 22:03 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
- correctly link paragraphs within list items
- consistently format examples
- put option alernatives on separate lines
- always use [verse] for config items
- always indent 1st paragraph of a list item, with a tab
Signed-off-by: Yann Dirson <ydirson@altern.org>
---
Documentation/git-svn.txt | 208 +++++++++++++++++++++-----------------------
1 files changed, 99 insertions(+), 109 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index a42f96a..b5b8366 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -26,7 +26,6 @@ Subversion updated from git by the 'dcommit' command.
COMMANDS
--------
---
'init'::
Initializes an empty git repository with additional
@@ -105,7 +104,7 @@ COMMANDS
--parent;;
Fetch only from the SVN parent of the current HEAD.
-
++
This doesn't interfere with interoperating with the Subversion
repository you cloned from, but if you wish for your local Git
repository to be able to interoperate with someone else's local Git
@@ -118,20 +117,28 @@ the same local timezone.
The '--ignore-paths' option should match for every 'fetch'
(including automatic fetches due to 'clone', 'dcommit',
'rebase', etc) on a given repository.
-
++
+[verse]
config key: svn-remote.<name>.ignore-paths
-
- If the ignore-paths config key is set and the command
- line option is also given, both regular expressions
- will be used.
-
++
+If the ignore-paths config key is set and the command line option is
+also given, both regular expressions will be used.
++
Examples:
++
+--
+Skip "doc*" directory for every fetch;;
++
+------------------------------------------------------------------------
+--ignore-paths="^doc"
+------------------------------------------------------------------------
- --ignore-paths="^doc" - skip "doc*" directory for every
- fetch.
-
- --ignore-paths="^[^/]+/(?:branches|tags)" - skip
- "branches" and "tags" of first level directories.
+Skip "branches" and "tags" of first level directories;;
++
+------------------------------------------------------------------------
+--ignore-paths="^[^/]+/(?:branches|tags)"
+------------------------------------------------------------------------
+--
'clone'::
Runs 'init' and 'fetch'. It will automatically create a
@@ -147,15 +154,15 @@ Examples:
'rebase'::
This fetches revisions from the SVN parent of the current HEAD
and rebases the current (uncommitted to SVN) work against it.
-
++
This works similarly to `svn update` or 'git pull' except that
it preserves linear history with 'git rebase' instead of
'git merge' for ease of dcommitting with 'git svn'.
-
++
This accepts all options that 'git svn fetch' and 'git rebase'
accept. However, '--fetch-all' only fetches from the current
[svn-remote], and not all [svn-remote] definitions.
-
++
Like 'git rebase'; this requires that the working tree be clean
and have no uncommitted changes.
@@ -186,14 +193,13 @@ and have no uncommitted changes.
method (e.g. `svn://` or `http://` for anonymous read) to be
reused if a user is later given access to an alternate transport
method (e.g. `svn+ssh://` or `https://`) for commit.
-
++
+[verse]
config key: svn-remote.<name>.commiturl
-
config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
-
- Using this option for any other purpose (don't ask)
- is very strongly discouraged.
---
++
+Using this option for any other purpose (don't ask) is very strongly
+discouraged.
'branch'::
Create a branch in the SVN repository.
@@ -235,7 +241,8 @@ The following features from `svn log' are supported:
-r/--revision=<n>[:<n>];;
is supported, non-numeric args are not:
HEAD, NEXT, BASE, PREV, etc ...
--v/--verbose;;
+-v;;
+--verbose;;
it's not completely compatible with the --verbose
output in svn log, but reasonably close.
--limit=<n>;;
@@ -274,7 +281,6 @@ Any other arguments are passed directly to 'git log'
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
---
'find-rev'::
When given an SVN revision number of the form 'rN', returns the
corresponding git commit hash (this can optionally be followed by a
@@ -340,58 +346,56 @@ Any other arguments are passed directly to 'git log'
"checksum mismatch" (missed a modification). If the problem
file cannot be ignored forever (with --ignore-paths) the only
way to repair the repo is to use 'reset'.
-
++
Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset'
with a 'fetch' and then 'git-reset' or 'git-rebase' to move local
branches onto the new tree.
--r/--revision=<n>;;
+-r;;
+--revision=<n>;;
Specify the most recent revision to keep. All later revisions
are discarded.
--p/--parent;;
+-p;;
+--parent;;
Discard the specified revision as well, keeping the nearest
parent instead.
Example:;;
Assume you have local changes in "master", but you need to refetch "r2".
-
++
------------
r1---r2---r3 remotes/git-svn
\
A---B master
------------
-
++
Fix the ignore-paths or SVN permissions problem that caused "r2" to
be incomplete in the first place. Then:
-
++
[verse]
git svn reset -r2 -p
git svn fetch
-
++
------------
r1---r2'--r3' remotes/git-svn
\
r2---r3---A---B master
------------
-
++
Then fixup "master" with 'git-rebase'.
Do NOT use 'git-merge' or your history will not be compatible with a
future 'dcommit'!
-
++
[verse]
git rebase --onto remotes/git-svn A^ master
-
++
------------
r1---r2'--r3' remotes/git-svn
\
A'--B' master
------------
-
---
-
OPTIONS
-------
---
--shared[={false|true|umask|group|all|world|everybody}]::
--template=<template_directory>::
@@ -400,85 +404,81 @@ OPTIONS
-r <ARG>::
--revision <ARG>::
-
-Used with the 'fetch' command.
-
+ Used with the 'fetch' command.
++
This allows revision ranges for partial/cauterized history
to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
$NUMBER:HEAD, and BASE:$NUMBER are all supported.
-
++
This can allow you to make partial mirrors when running fetch;
but is generally not recommended because history will be skipped
and lost.
-::
--stdin::
-
-Only used with the 'set-tree' command.
-
+ Only used with the 'set-tree' command.
++
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
'git rev-list --pretty=oneline' output can be used.
--rmdir::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
Remove directories from the SVN tree if there are no files left
behind. SVN can version empty directories, and they are not
removed by default if there are no files left in them. git
cannot version empty directories. Enabling this flag will make
the commit to SVN act like git.
-
++
+[verse]
config key: svn.rmdir
-e::
--edit::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
Edit the commit message before committing to SVN. This is off by
default for objects that are commits, and forced on when committing
tree objects.
-
++
+[verse]
config key: svn.edit
-l<num>::
--find-copies-harder::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
They are both passed directly to 'git diff-tree'; see
linkgit:git-diff-tree[1] for more information.
-
++
[verse]
config key: svn.l
config key: svn.findcopiesharder
-A<filename>::
--authors-file=<filename>::
-
-Syntax is compatible with the file used by 'git cvsimport':
-
+ Syntax is compatible with the file used by '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.
-
++
+[verse]
config key: svn.authorsfile
--authors-prog=<filename>::
-
-If this option is specified, for each SVN committer name that does not
-exist in the authors file, the given file is executed with the committer
-name as the first argument. The program is expected to return a single
-line of the form "Name <email>", which will be treated as if included in
-the authors file.
+ If this option is specified, for each SVN committer name that
+ does not exist in the authors file, the given file is executed
+ with the committer name as the first argument. The program is
+ expected to return a single line of the form "Name <email>",
+ which will be treated as if included in the authors file.
-q::
--quiet::
@@ -487,16 +487,15 @@ the authors file.
--repack[=<n>]::
--repack-flags=<flags>::
-
-These should help keep disk usage sane for large fetches
-with many revisions.
-
+ These should help keep disk usage sane for large fetches with
+ many revisions.
++
--repack takes an optional argument for the number of revisions
to fetch before repacking. This defaults to repacking every
1000 commits fetched if no argument is specified.
-
++
--repack-flags are passed directly to 'git repack'.
-
++
[verse]
config key: svn.repack
config key: svn.repackflags
@@ -505,41 +504,36 @@ config key: svn.repackflags
--merge::
-s<strategy>::
--strategy=<strategy>::
-
-These are only used with the 'dcommit' and 'rebase' commands.
-
+ These are only used with the 'dcommit' and 'rebase' commands.
++
Passed directly to 'git rebase' when using 'dcommit' if a
'git reset' cannot be used (see 'dcommit').
-n::
--dry-run::
-
-This can be used with the 'dcommit', 'rebase', 'branch' and 'tag'
-commands.
-
+ This can be used with the 'dcommit', 'rebase', 'branch' and
+ 'tag' commands.
++
For 'dcommit', print out the series of git arguments that would show
which diffs would be committed to SVN.
-
++
For 'rebase', display the local branch associated with the upstream svn
repository associated with the current branch and the URL of svn
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.
---
ADVANCED OPTIONS
----------------
---
-i<GIT_SVN_ID>::
--id <GIT_SVN_ID>::
-
-This sets GIT_SVN_ID (instead of using the environment). This
-allows the user to override the default refname to fetch from
-when tracking a single URL. The 'log' and 'dcommit' commands
-no longer require this switch as an argument.
+ This sets GIT_SVN_ID (instead of using the environment). This
+ allows the user to override the default refname to fetch from
+ when tracking a single URL. The 'log' and 'dcommit' commands
+ no longer require this switch as an argument.
-R<remote name>::
--svn-remote <remote name>::
@@ -553,33 +547,30 @@ no longer require this switch as an argument.
started tracking a branch and never tracked the trunk it was
descended from. This feature is enabled by default, use
--no-follow-parent to disable it.
-
++
+[verse]
config key: svn.followparent
---
CONFIG FILE-ONLY OPTIONS
------------------------
---
svn.noMetadata::
svn-remote.<name>.noMetadata::
-
-This gets rid of the 'git-svn-id:' lines at the end of every commit.
-
+ This gets rid of the 'git-svn-id:' lines at the end of every commit.
++
If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not
be able to rebuild it and you won't be able to fetch again,
either. This is fine for one-shot imports.
-
++
The 'git svn log' command will not work on repositories using
this, either. Using this conflicts with the 'useSvmProps'
option for (hopefully) obvious reasons.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
-
-This allows 'git svn' to re-map repository URLs and UUIDs from
-mirrors created using SVN::Mirror (or svk) for metadata.
-
+ This allows 'git svn' to re-map repository URLs and UUIDs from
+ mirrors created using SVN::Mirror (or svk) for metadata.
++
If an SVN revision has a property, "svm:headrev", it is likely
that the revision was created by SVN::Mirror (also used by SVK).
The property contains a repository UUID and a revision. We want
@@ -602,14 +593,13 @@ svn-remote.<name>.rewriteRoot::
metadata so users of it will see the public URL.
svn.brokenSymlinkWorkaround::
-This disables potentially expensive checks to workaround broken symlinks
-checked into SVN by broken clients. Set this option to "false" if you
-track a SVN repository with many empty blobs that are not symlinks.
-This option may be changed while 'git svn' is running and take effect on
-the next revision fetched. If unset, 'git svn' assumes this option to be
-"true".
-
---
+ This disables potentially expensive checks to workaround
+ broken symlinks checked into SVN by broken clients. Set this
+ option to "false" if you track a SVN repository with many
+ empty blobs that are not symlinks. This option may be changed
+ while 'git svn' is running and take effect on the next
+ revision fetched. If unset, 'git svn' assumes this option to
+ be "true".
Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
options all affect the metadata generated and used by 'git svn'; they
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags.
2009-07-05 22:03 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
@ 2009-07-05 22:03 ` Yann Dirson
2009-07-05 22:03 ` [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-05 22:03 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Signed-off-by: Yann Dirson <ydirson@altern.org>
---
Documentation/git-svn.txt | 21 +++++++++++----------
1 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index b5b8366..03bc1c1 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -62,16 +62,6 @@ COMMANDS
Set the 'useSvnsyncProps' option in the [svn-remote] config.
--rewrite-root=<URL>;;
Set the 'rewriteRoot' option in the [svn-remote] config.
---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.
--username=<USER>;;
For transports that SVN handles authentication for (http,
https, and plain svn), specify the username. For other
@@ -140,6 +130,17 @@ 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;
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone.
2009-07-05 22:03 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
@ 2009-07-05 22:03 ` Yann Dirson
0 siblings, 0 replies; 17+ messages in thread
From: Yann Dirson @ 2009-07-05 22:03 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Signed-off-by: Yann Dirson <ydirson@altern.org>
---
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 03bc1c1..1e56466 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -147,10 +147,10 @@ Skip "branches" and "tags" of first level directories;;
or if a second argument is passed; it will create a directory
and work within that. It accepts all arguments that the
'init' and 'fetch' commands accept; with the exception of
- '--fetch-all'. After a repository is cloned, the 'fetch'
- command will be able to update revisions without affecting
- the working tree; and the 'rebase' command will be able
- to update the working tree with the latest changes.
+ '--fetch-all' and '--parent'. After a repository is cloned,
+ the 'fetch' command will be able to update revisions without
+ affecting the working tree; and the 'rebase' command will be
+ able to update the working tree with the latest changes.
'rebase'::
This fetches revisions from the SVN parent of the current HEAD
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* Re: [PATCH 0/4] First set of improvements to git-svn user doc
2009-07-05 22:03 [PATCH 0/4] First set of improvements to git-svn user doc Yann Dirson
2009-07-05 22:03 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
@ 2009-07-06 22:20 ` Eric Wong
2009-07-07 13:02 ` [PATCHv2 " Yann Dirson
` (2 more replies)
1 sibling, 3 replies; 17+ messages in thread
From: Eric Wong @ 2009-07-06 22:20 UTC (permalink / raw)
To: Junio C Hamano; +Cc: git, Yann Dirson
Yann Dirson <ydirson@altern.org> wrote:
> From my previous post, I have splitted the changes to the manpage for easier
> review and incremental integration. Here are the parts I consider mature
> enough to be proposed into master. The other ones are still WIP and I'll
> repost them when I have made real progress on them.
>
> Yann Dirson (4):
> git-svn.txt: stop using dash-form of commands.
> git-svn.txt: make formatting more consistent.
> git-svn.txt: fix fetch flags incorrectly documented as init flags.
> git-svn.txt: fix description of fetch flags accepted by clone.
Thanks Yann,
Text-wise, these changes look good and I trust you won't knowingly
introduce formatting errors, so consider them:
Acked-by: Eric Wong <normalperson@yhbt.net>
On a side note, what kind of machine is needed to build documentation at
non-painful speeds these days?
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCHv2 0/4] First set of improvements to git-svn user doc
2009-07-06 22:20 ` [PATCH 0/4] First set of improvements to git-svn user doc Eric Wong
@ 2009-07-07 13:02 ` Yann Dirson
2009-07-07 13:02 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
2009-07-07 13:22 ` [PATCH 0/4] First set of improvements to git-svn user doc Yann Dirson
2009-07-07 20:22 ` [PATCHv3 " Yann Dirson
2 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 13:02 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
This series is a minor update which should be better for inclusion:
I had missed a few recently-introduced dash-form of commands while
rebasing. It also adds Acked-by: Eric to the series.
Yann Dirson (4):
git-svn.txt: stop using dash-form of commands.
git-svn.txt: make formatting more consistent.
git-svn.txt: fix fetch flags incorrectly documented as init flags.
git-svn.txt: fix description of fetch flags accepted by clone.
Documentation/git-svn.txt | 347 ++++++++++++++++++++++-----------------------
1 files changed, 169 insertions(+), 178 deletions(-)
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 1/4] git-svn.txt: stop using dash-form of commands.
2009-07-07 13:02 ` [PATCHv2 " Yann Dirson
@ 2009-07-07 13:02 ` Yann Dirson
2009-07-07 13:02 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 13:02 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Also consistently use single quotes around git commands to make things clear
(was only needed at a couple of places).
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
Documentation/git-svn.txt | 120 ++++++++++++++++++++++----------------------
1 files changed, 60 insertions(+), 60 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 7e9b9a0..2818bcc 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -11,11 +11,11 @@ SYNOPSIS
DESCRIPTION
-----------
-'git-svn' is a simple conduit for changesets between Subversion and git.
+'git svn' is a simple conduit for changesets between Subversion and git.
It provides a bidirectional flow of changes between a Subversion and a git
repository.
-'git-svn' can track a standard Subversion repository,
+'git svn' can track a standard Subversion repository,
following the common "trunk/branches/tags" layout, with the --stdlayout option.
It can also follow branches and tags in any layout with the -T/-t/-b options
(see options to 'init' below, and also the 'clone' command).
@@ -30,7 +30,7 @@ COMMANDS
'init'::
Initializes an empty git repository with additional
- metadata directories for 'git-svn'. The Subversion URL
+ metadata directories for 'git svn'. The Subversion URL
may be specified as a command-line argument, or as full
URL arguments to -T/-t/-b. Optionally, the target
directory to operate on can be specified as a second
@@ -100,7 +100,7 @@ COMMANDS
--localtime;;
Store Git commit times in the local timezone instead of UTC. This
- makes 'git-log' (even without --date=local) show the same times
+ makes 'git log' (even without --date=local) show the same times
that `svn log` would in the local timezone.
--parent;;
@@ -148,20 +148,20 @@ Examples:
This fetches revisions from the SVN parent of the current HEAD
and rebases the current (uncommitted to SVN) work against it.
-This works similarly to `svn update` or 'git-pull' except that
-it preserves linear history with 'git-rebase' instead of
-'git-merge' for ease of dcommitting with 'git-svn'.
+This works similarly to `svn update` or 'git pull' except that
+it preserves linear history with 'git rebase' instead of
+'git merge' for ease of dcommitting with 'git svn'.
-This accepts all options that 'git-svn fetch' and 'git-rebase'
+This accepts all options that 'git svn fetch' and 'git rebase'
accept. However, '--fetch-all' only fetches from the current
[svn-remote], and not all [svn-remote] definitions.
-Like 'git-rebase'; this requires that the working tree be clean
+Like 'git rebase'; this requires that the working tree be clean
and have no uncommitted changes.
-l;;
--local;;
- Do not fetch remotely; only run 'git-rebase' against the
+ Do not fetch remotely; only run 'git rebase' against the
last fetched commit from the upstream SVN.
'dcommit'::
@@ -169,11 +169,11 @@ and have no uncommitted changes.
repository, and then rebase or reset (depending on whether or
not there is a diff between SVN and head). This will create
a revision in SVN for each commit in git.
- It is recommended that you run 'git-svn' fetch and rebase (not
+ It is recommended that you run 'git svn' fetch and rebase (not
pull or merge) your commits against the latest changes in the
SVN repository.
An optional revision or branch argument may be specified, and
- causes 'git-svn' to do all work on that revision/branch
+ causes 'git svn' to do all work on that revision/branch
instead of HEAD.
This is advantageous over 'set-tree' (below) because it produces
cleaner, more linear history.
@@ -182,7 +182,7 @@ and have no uncommitted changes.
After committing, do not rebase or reset.
--commit-url <URL>;;
Commit to this SVN URL (the full path). This is intended to
- allow existing git-svn repositories created with one transport
+ allow existing 'git svn' repositories created with one transport
method (e.g. `svn://` or `http://` for anonymous read) to be
reused if a user is later given access to an alternate transport
method (e.g. `svn+ssh://` or `https://`) for commit.
@@ -258,7 +258,7 @@ NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
client converts the UTC time to the local time (or based on the TZ=
environment). This command has the same behaviour.
+
-Any other arguments are passed directly to 'git-log'
+Any other arguments are passed directly to 'git log'
'blame'::
Show what revision and author last modified each line of a file. The
@@ -266,10 +266,10 @@ Any other arguments are passed directly to 'git-log'
`svn blame' by default. Like the SVN blame command,
local uncommitted changes in the working copy are ignored;
the version of the file in the HEAD revision is annotated. Unknown
- arguments are passed directly to 'git-blame'.
+ arguments are passed directly to 'git blame'.
+
--git-format;;
- Produce output in the same format as 'git-blame', but with
+ Produce output in the same format as 'git blame', but with
SVN revision numbers instead of git commit hashes. In this mode,
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
@@ -288,7 +288,7 @@ Any other arguments are passed directly to 'git-log'
absolutely no attempts to do patching when committing to SVN, it
simply overwrites files with those specified in the tree or
commit. All merging is assumed to have taken place
- independently of 'git-svn' functions.
+ independently of 'git svn' functions.
'create-ignore'::
Recursively finds the svn:ignore property on directories and
@@ -303,12 +303,12 @@ Any other arguments are passed directly to 'git-log'
'commit-diff'::
Commits the diff of two tree-ish arguments from the
- command-line. This command does not rely on being inside an `git-svn
+ command-line. This command does not rely on being inside an `git svn
init`-ed repository. This command takes three arguments, (a) the
original tree to diff against, (b) the new tree result, (c) the
URL of the target Subversion repository. The final argument
- (URL) may be omitted if you are working from a 'git-svn'-aware
- repository (that has been `init`-ed with 'git-svn').
+ (URL) may be omitted if you are working from a 'git svn'-aware
+ repository (that has been `init`-ed with 'git svn').
The -r<revision> option is required for this.
'info'::
@@ -342,7 +342,7 @@ Any other arguments are passed directly to 'git-log'
way to repair the repo is to use 'reset'.
Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset'
-with a 'fetch' and then 'git-reset' or 'git-rebase' to move local
+with a 'fetch' and then 'git reset' or 'git rebase' to move local
branches onto the new tree.
-r/--revision=<n>;;
@@ -373,8 +373,8 @@ git svn fetch
r2---r3---A---B master
------------
-Then fixup "master" with 'git-rebase'.
-Do NOT use 'git-merge' or your history will not be compatible with a
+Then fixup "master" with 'git rebase'.
+Do NOT use 'git merge' or your history will not be compatible with a
future 'dcommit'!
[verse]
@@ -396,7 +396,7 @@ OPTIONS
--shared[={false|true|umask|group|all|world|everybody}]::
--template=<template_directory>::
Only used with the 'init' command.
- These are passed directly to 'git-init'.
+ These are passed directly to 'git init'.
-r <ARG>::
--revision <ARG>::
@@ -418,7 +418,7 @@ Only used with the 'set-tree' command.
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
-'git-rev-list --pretty=oneline' output can be used.
+'git rev-list --pretty=oneline' output can be used.
--rmdir::
@@ -448,7 +448,7 @@ config key: svn.edit
Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-They are both passed directly to 'git-diff-tree'; see
+They are both passed directly to 'git diff-tree'; see
linkgit:git-diff-tree[1] for more information.
[verse]
@@ -458,16 +458,16 @@ config key: svn.findcopiesharder
-A<filename>::
--authors-file=<filename>::
-Syntax is compatible with the file used by 'git-cvsimport':
+Syntax is compatible with the file used by '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'
+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
+appropriate entry. Re-running the previous 'git svn' command
after the authors-file is modified should continue operation.
config key: svn.authorsfile
@@ -482,7 +482,7 @@ the authors file.
-q::
--quiet::
- Make 'git-svn' less verbose. Specify a second time to make it
+ Make 'git svn' less verbose. Specify a second time to make it
even less verbose.
--repack[=<n>]::
@@ -495,7 +495,7 @@ with many revisions.
to fetch before repacking. This defaults to repacking every
1000 commits fetched if no argument is specified.
---repack-flags are passed directly to 'git-repack'.
+--repack-flags are passed directly to 'git repack'.
[verse]
config key: svn.repack
@@ -508,8 +508,8 @@ config key: svn.repackflags
These are only used with the 'dcommit' and 'rebase' commands.
-Passed directly to 'git-rebase' when using 'dcommit' if a
-'git-reset' cannot be used (see 'dcommit').
+Passed directly to 'git rebase' when using 'dcommit' if a
+'git reset' cannot be used (see 'dcommit').
-n::
--dry-run::
@@ -566,18 +566,18 @@ svn-remote.<name>.noMetadata::
This gets rid of the 'git-svn-id:' lines at the end of every commit.
-If you lose your .git/svn/git-svn/.rev_db file, 'git-svn' will not
+If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not
be able to rebuild it and you won't be able to fetch again,
either. This is fine for one-shot imports.
-The 'git-svn log' command will not work on repositories using
+The 'git svn log' command will not work on repositories using
this, either. Using this conflicts with the 'useSvmProps'
option for (hopefully) obvious reasons.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
-This allows 'git-svn' to re-map repository URLs and UUIDs from
+This allows 'git svn' to re-map repository URLs and UUIDs from
mirrors created using SVN::Mirror (or svk) for metadata.
If an SVN revision has a property, "svm:headrev", it is likely
@@ -596,7 +596,7 @@ svn-remote.<name>.useSvnsyncprops::
svn-remote.<name>.rewriteRoot::
This allows users to create repositories from alternate
- URLs. For example, an administrator could run 'git-svn' on the
+ URLs. For example, an administrator could run 'git svn' on the
server locally (accessing via file://) but wish to distribute
the repository with a public http:// or svn:// URL in the
metadata so users of it will see the public URL.
@@ -605,14 +605,14 @@ svn.brokenSymlinkWorkaround::
This disables potentially expensive checks to workaround broken symlinks
checked into SVN by broken clients. Set this option to "false" if you
track a SVN repository with many empty blobs that are not symlinks.
-This option may be changed while "git-svn" is running and take effect on
-the next revision fetched. If unset, git-svn assumes this option to be
+This option may be changed while 'git svn' is running and take effect on
+the next revision fetched. If unset, 'git svn' assumes this option to be
"true".
--
Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
-options all affect the metadata generated and used by 'git-svn'; they
+options all affect the metadata generated and used by 'git svn'; they
*must* be set in the configuration file before any history is imported
and these settings should never be changed once they are set.
@@ -630,7 +630,7 @@ Tracking and contributing to the trunk of a Subversion-managed project:
git svn clone http://svn.example.com/project/trunk
# Enter the newly cloned directory:
cd trunk
-# You should be on master branch, double-check with git-branch
+# You should be on master branch, double-check with 'git branch'
git branch
# Do some work and commit locally to git:
git commit ...
@@ -661,12 +661,12 @@ Tracking and contributing to an entire Subversion-managed project
# of dcommit/rebase/show-ignore should be the same as above.
------------------------------------------------------------------------
-The initial 'git-svn clone' can be quite time-consuming
+The initial 'git svn clone' can be quite time-consuming
(especially for large Subversion repositories). If multiple
people (or one person with multiple machines) want to use
-'git-svn' to interact with the same Subversion repository, you can
-do the initial 'git-svn clone' to a repository on a server and
-have each person clone that repository with 'git-clone':
+'git svn' to interact with the same Subversion repository, you can
+do the initial 'git svn clone' to a repository on a server and
+have each person clone that repository with 'git clone':
------------------------------------------------------------------------
# Do the initial import on a server
@@ -680,7 +680,7 @@ have each person clone that repository with 'git-clone':
git fetch
# Create a local branch from one of the branches just fetched
git checkout -b master FETCH_HEAD
-# Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server)
+# Initialize 'git svn' locally (be sure to use the same URL and -T/-b/-t options as were used on server)
git svn init http://svn.example.com/project
# Pull the latest changes from Subversion
git svn rebase
@@ -689,7 +689,7 @@ have each person clone that repository with 'git-clone':
REBASE VS. PULL/MERGE
---------------------
-Originally, 'git-svn' recommended that the 'remotes/git-svn' branch be
+Originally, 'git svn' recommended that the 'remotes/git-svn' branch be
pulled or merged from. This is because the author favored
`git svn set-tree B` to commit a single head rather than the
`git svn set-tree A..B` notation to commit multiple commits.
@@ -704,7 +704,7 @@ previous commits in SVN.
DESIGN PHILOSOPHY
-----------------
Merge tracking in Subversion is lacking and doing branched development
-with Subversion can be cumbersome as a result. While 'git-svn' can track
+with Subversion can be cumbersome as a result. While 'git svn' can track
copy history (including branches and tags) for repositories adopting a
standard layout, it cannot yet represent merge history that happened
inside git back upstream to SVN users. Therefore it is advised that
@@ -715,25 +715,25 @@ CAVEATS
-------
For the sake of simplicity and interoperating with a less-capable system
-(SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit
-directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push'
+(SVN), it is recommended that all 'git svn' users clone, fetch and dcommit
+directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
operations between git repositories and branches. The recommended
method of exchanging code between git branches and users is
-'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository.
+'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
-Running 'git-merge' or 'git-pull' is NOT recommended on a branch you
+Running 'git merge' or 'git pull' is NOT recommended on a branch you
plan to 'dcommit' from. Subversion does not represent merges in any
reasonable or useful fashion; so users using Subversion cannot see any
merges you've made. Furthermore, if you merge or pull from a git branch
that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
branch.
-'git-clone' does not clone branches under the refs/remotes/ hierarchy or
-any 'git-svn' metadata, or config. So repositories created and managed with
-using 'git-svn' should use 'rsync' for cloning, if cloning is to be done
+'git clone' does not clone branches under the refs/remotes/ hierarchy or
+any 'git svn' metadata, or config. So repositories created and managed with
+using 'git svn' should use 'rsync' for cloning, if cloning is to be done
at all.
-Since 'dcommit' uses rebase internally, any git branches you 'git-push' to
+Since 'dcommit' uses rebase internally, any git branches you 'git push' to
before 'dcommit' on will require forcing an overwrite of the existing ref
on the remote repository. This is generally considered bad practice,
see the linkgit:git-push[1] documentation for details.
@@ -743,7 +743,7 @@ already dcommitted. It is considered bad practice to --amend commits
you've already pushed to a remote repository for other users, and
dcommit with SVN is analogous to that.
-When using multiple --branches or --tags, 'git-svn' does not automatically
+When using multiple --branches or --tags, 'git svn' does not automatically
handle name collisions (for example, if two branches from different paths have
the same name, or if a branch and a tag have the same name). In these cases,
use 'init' to set up your git repository then, before your first 'fetch', edit
@@ -769,7 +769,7 @@ for git to detect them.
CONFIGURATION
-------------
-'git-svn' stores [svn-remote] configuration information in the
+'git svn' stores [svn-remote] configuration information in the
repository .git/config file. It is similar the core git
[remote] sections except 'fetch' keys do not accept glob
arguments; but they are instead handled by the 'branches'
@@ -790,7 +790,7 @@ Keep in mind that the '\*' (asterisk) wildcard of the local ref
however the remote wildcard may be anywhere as long as it's an
independent path component (surrounded by '/' or EOL). This
type of configuration is not automatically created by 'init' and
-should be manually entered with a text-editor or using 'git-config'.
+should be manually entered with a text-editor or using 'git config'.
SEE ALSO
--------
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 2/4] git-svn.txt: make formatting more consistent.
2009-07-07 13:02 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
@ 2009-07-07 13:02 ` Yann Dirson
2009-07-07 13:02 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 13:02 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
- correctly link paragraphs within list items
- consistently format examples
- put option alernatives on separate lines
- always use [verse] for config items
- always indent 1st paragraph of a list item, with a tab
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
Documentation/git-svn.txt | 208 +++++++++++++++++++++-----------------------
1 files changed, 99 insertions(+), 109 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 2818bcc..3599e01 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -26,7 +26,6 @@ Subversion updated from git by the 'dcommit' command.
COMMANDS
--------
---
'init'::
Initializes an empty git repository with additional
@@ -105,7 +104,7 @@ COMMANDS
--parent;;
Fetch only from the SVN parent of the current HEAD.
-
++
This doesn't interfere with interoperating with the Subversion
repository you cloned from, but if you wish for your local Git
repository to be able to interoperate with someone else's local Git
@@ -118,20 +117,28 @@ the same local timezone.
The '--ignore-paths' option should match for every 'fetch'
(including automatic fetches due to 'clone', 'dcommit',
'rebase', etc) on a given repository.
-
++
+[verse]
config key: svn-remote.<name>.ignore-paths
-
- If the ignore-paths config key is set and the command
- line option is also given, both regular expressions
- will be used.
-
++
+If the ignore-paths config key is set and the command line option is
+also given, both regular expressions will be used.
++
Examples:
++
+--
+Skip "doc*" directory for every fetch;;
++
+------------------------------------------------------------------------
+--ignore-paths="^doc"
+------------------------------------------------------------------------
- --ignore-paths="^doc" - skip "doc*" directory for every
- fetch.
-
- --ignore-paths="^[^/]+/(?:branches|tags)" - skip
- "branches" and "tags" of first level directories.
+Skip "branches" and "tags" of first level directories;;
++
+------------------------------------------------------------------------
+--ignore-paths="^[^/]+/(?:branches|tags)"
+------------------------------------------------------------------------
+--
'clone'::
Runs 'init' and 'fetch'. It will automatically create a
@@ -147,15 +154,15 @@ Examples:
'rebase'::
This fetches revisions from the SVN parent of the current HEAD
and rebases the current (uncommitted to SVN) work against it.
-
++
This works similarly to `svn update` or 'git pull' except that
it preserves linear history with 'git rebase' instead of
'git merge' for ease of dcommitting with 'git svn'.
-
++
This accepts all options that 'git svn fetch' and 'git rebase'
accept. However, '--fetch-all' only fetches from the current
[svn-remote], and not all [svn-remote] definitions.
-
++
Like 'git rebase'; this requires that the working tree be clean
and have no uncommitted changes.
@@ -186,14 +193,13 @@ and have no uncommitted changes.
method (e.g. `svn://` or `http://` for anonymous read) to be
reused if a user is later given access to an alternate transport
method (e.g. `svn+ssh://` or `https://`) for commit.
-
++
+[verse]
config key: svn-remote.<name>.commiturl
-
config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
-
- Using this option for any other purpose (don't ask)
- is very strongly discouraged.
---
++
+Using this option for any other purpose (don't ask) is very strongly
+discouraged.
'branch'::
Create a branch in the SVN repository.
@@ -235,7 +241,8 @@ The following features from `svn log' are supported:
-r/--revision=<n>[:<n>];;
is supported, non-numeric args are not:
HEAD, NEXT, BASE, PREV, etc ...
--v/--verbose;;
+-v;;
+--verbose;;
it's not completely compatible with the --verbose
output in svn log, but reasonably close.
--limit=<n>;;
@@ -274,7 +281,6 @@ Any other arguments are passed directly to 'git log'
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
---
'find-rev'::
When given an SVN revision number of the form 'rN', returns the
corresponding git commit hash (this can optionally be followed by a
@@ -340,58 +346,56 @@ Any other arguments are passed directly to 'git log'
"checksum mismatch" (missed a modification). If the problem
file cannot be ignored forever (with --ignore-paths) the only
way to repair the repo is to use 'reset'.
-
++
Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset'
with a 'fetch' and then 'git reset' or 'git rebase' to move local
branches onto the new tree.
--r/--revision=<n>;;
+-r;;
+--revision=<n>;;
Specify the most recent revision to keep. All later revisions
are discarded.
--p/--parent;;
+-p;;
+--parent;;
Discard the specified revision as well, keeping the nearest
parent instead.
Example:;;
Assume you have local changes in "master", but you need to refetch "r2".
-
++
------------
r1---r2---r3 remotes/git-svn
\
A---B master
------------
-
++
Fix the ignore-paths or SVN permissions problem that caused "r2" to
be incomplete in the first place. Then:
-
++
[verse]
git svn reset -r2 -p
git svn fetch
-
++
------------
r1---r2'--r3' remotes/git-svn
\
r2---r3---A---B master
------------
-
++
Then fixup "master" with 'git rebase'.
Do NOT use 'git merge' or your history will not be compatible with a
future 'dcommit'!
-
++
[verse]
git rebase --onto remotes/git-svn A^ master
-
++
------------
r1---r2'--r3' remotes/git-svn
\
A'--B' master
------------
-
---
-
OPTIONS
-------
---
--shared[={false|true|umask|group|all|world|everybody}]::
--template=<template_directory>::
@@ -400,85 +404,81 @@ OPTIONS
-r <ARG>::
--revision <ARG>::
-
-Used with the 'fetch' command.
-
+ Used with the 'fetch' command.
++
This allows revision ranges for partial/cauterized history
to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
$NUMBER:HEAD, and BASE:$NUMBER are all supported.
-
++
This can allow you to make partial mirrors when running fetch;
but is generally not recommended because history will be skipped
and lost.
-::
--stdin::
-
-Only used with the 'set-tree' command.
-
+ Only used with the 'set-tree' command.
++
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
'git rev-list --pretty=oneline' output can be used.
--rmdir::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
Remove directories from the SVN tree if there are no files left
behind. SVN can version empty directories, and they are not
removed by default if there are no files left in them. git
cannot version empty directories. Enabling this flag will make
the commit to SVN act like git.
-
++
+[verse]
config key: svn.rmdir
-e::
--edit::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
Edit the commit message before committing to SVN. This is off by
default for objects that are commits, and forced on when committing
tree objects.
-
++
+[verse]
config key: svn.edit
-l<num>::
--find-copies-harder::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
They are both passed directly to 'git diff-tree'; see
linkgit:git-diff-tree[1] for more information.
-
++
[verse]
config key: svn.l
config key: svn.findcopiesharder
-A<filename>::
--authors-file=<filename>::
-
-Syntax is compatible with the file used by 'git cvsimport':
-
+ Syntax is compatible with the file used by '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.
-
++
+[verse]
config key: svn.authorsfile
--authors-prog=<filename>::
-
-If this option is specified, for each SVN committer name that does not
-exist in the authors file, the given file is executed with the committer
-name as the first argument. The program is expected to return a single
-line of the form "Name <email>", which will be treated as if included in
-the authors file.
+ If this option is specified, for each SVN committer name that
+ does not exist in the authors file, the given file is executed
+ with the committer name as the first argument. The program is
+ expected to return a single line of the form "Name <email>",
+ which will be treated as if included in the authors file.
-q::
--quiet::
@@ -487,16 +487,15 @@ the authors file.
--repack[=<n>]::
--repack-flags=<flags>::
-
-These should help keep disk usage sane for large fetches
-with many revisions.
-
+ These should help keep disk usage sane for large fetches with
+ many revisions.
++
--repack takes an optional argument for the number of revisions
to fetch before repacking. This defaults to repacking every
1000 commits fetched if no argument is specified.
-
++
--repack-flags are passed directly to 'git repack'.
-
++
[verse]
config key: svn.repack
config key: svn.repackflags
@@ -505,41 +504,36 @@ config key: svn.repackflags
--merge::
-s<strategy>::
--strategy=<strategy>::
-
-These are only used with the 'dcommit' and 'rebase' commands.
-
+ These are only used with the 'dcommit' and 'rebase' commands.
++
Passed directly to 'git rebase' when using 'dcommit' if a
'git reset' cannot be used (see 'dcommit').
-n::
--dry-run::
-
-This can be used with the 'dcommit', 'rebase', 'branch' and 'tag'
-commands.
-
+ This can be used with the 'dcommit', 'rebase', 'branch' and
+ 'tag' commands.
++
For 'dcommit', print out the series of git arguments that would show
which diffs would be committed to SVN.
-
++
For 'rebase', display the local branch associated with the upstream svn
repository associated with the current branch and the URL of svn
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.
---
ADVANCED OPTIONS
----------------
---
-i<GIT_SVN_ID>::
--id <GIT_SVN_ID>::
-
-This sets GIT_SVN_ID (instead of using the environment). This
-allows the user to override the default refname to fetch from
-when tracking a single URL. The 'log' and 'dcommit' commands
-no longer require this switch as an argument.
+ This sets GIT_SVN_ID (instead of using the environment). This
+ allows the user to override the default refname to fetch from
+ when tracking a single URL. The 'log' and 'dcommit' commands
+ no longer require this switch as an argument.
-R<remote name>::
--svn-remote <remote name>::
@@ -553,33 +547,30 @@ no longer require this switch as an argument.
started tracking a branch and never tracked the trunk it was
descended from. This feature is enabled by default, use
--no-follow-parent to disable it.
-
++
+[verse]
config key: svn.followparent
---
CONFIG FILE-ONLY OPTIONS
------------------------
---
svn.noMetadata::
svn-remote.<name>.noMetadata::
-
-This gets rid of the 'git-svn-id:' lines at the end of every commit.
-
+ This gets rid of the 'git-svn-id:' lines at the end of every commit.
++
If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not
be able to rebuild it and you won't be able to fetch again,
either. This is fine for one-shot imports.
-
++
The 'git svn log' command will not work on repositories using
this, either. Using this conflicts with the 'useSvmProps'
option for (hopefully) obvious reasons.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
-
-This allows 'git svn' to re-map repository URLs and UUIDs from
-mirrors created using SVN::Mirror (or svk) for metadata.
-
+ This allows 'git svn' to re-map repository URLs and UUIDs from
+ mirrors created using SVN::Mirror (or svk) for metadata.
++
If an SVN revision has a property, "svm:headrev", it is likely
that the revision was created by SVN::Mirror (also used by SVK).
The property contains a repository UUID and a revision. We want
@@ -602,14 +593,13 @@ svn-remote.<name>.rewriteRoot::
metadata so users of it will see the public URL.
svn.brokenSymlinkWorkaround::
-This disables potentially expensive checks to workaround broken symlinks
-checked into SVN by broken clients. Set this option to "false" if you
-track a SVN repository with many empty blobs that are not symlinks.
-This option may be changed while 'git svn' is running and take effect on
-the next revision fetched. If unset, 'git svn' assumes this option to be
-"true".
-
---
+ This disables potentially expensive checks to workaround
+ broken symlinks checked into SVN by broken clients. Set this
+ option to "false" if you track a SVN repository with many
+ empty blobs that are not symlinks. This option may be changed
+ while 'git svn' is running and take effect on the next
+ revision fetched. If unset, 'git svn' assumes this option to
+ be "true".
Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
options all affect the metadata generated and used by 'git svn'; they
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags.
2009-07-07 13:02 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
@ 2009-07-07 13:02 ` Yann Dirson
2009-07-07 13:02 ` [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 13:02 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
Documentation/git-svn.txt | 21 +++++++++++----------
1 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 3599e01..d08b2ad 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -62,16 +62,6 @@ COMMANDS
Set the 'useSvnsyncProps' option in the [svn-remote] config.
--rewrite-root=<URL>;;
Set the 'rewriteRoot' option in the [svn-remote] config.
---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.
--username=<USER>;;
For transports that SVN handles authentication for (http,
https, and plain svn), specify the username. For other
@@ -140,6 +130,17 @@ 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;
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone.
2009-07-07 13:02 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
@ 2009-07-07 13:02 ` Yann Dirson
0 siblings, 0 replies; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 13:02 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
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 d08b2ad..d7f30d5 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -147,10 +147,10 @@ Skip "branches" and "tags" of first level directories;;
or if a second argument is passed; it will create a directory
and work within that. It accepts all arguments that the
'init' and 'fetch' commands accept; with the exception of
- '--fetch-all'. After a repository is cloned, the 'fetch'
- command will be able to update revisions without affecting
- the working tree; and the 'rebase' command will be able
- to update the working tree with the latest changes.
+ '--fetch-all' and '--parent'. After a repository is cloned,
+ the 'fetch' command will be able to update revisions without
+ affecting the working tree; and the 'rebase' command will be
+ able to update the working tree with the latest changes.
'rebase'::
This fetches revisions from the SVN parent of the current HEAD
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* Re: [PATCH 0/4] First set of improvements to git-svn user doc
2009-07-06 22:20 ` [PATCH 0/4] First set of improvements to git-svn user doc Eric Wong
2009-07-07 13:02 ` [PATCHv2 " Yann Dirson
@ 2009-07-07 13:22 ` Yann Dirson
2009-07-07 20:22 ` [PATCHv3 " Yann Dirson
2 siblings, 0 replies; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 13:22 UTC (permalink / raw)
To: Eric Wong; +Cc: Junio C Hamano, git
mOn Mon, Jul 06, 2009 at 03:20:28PM -0700, Eric Wong wrote:
> On a side note, what kind of machine is needed to build documentation at
> non-painful speeds these days?
Well, working myself on an nearly 10-years 1GHz machine (but still a
bipro, who do you think I am ;), I also find it quite painful, so I
just build the doc I'm working on:
make -C Documentation/ git-svn.html
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCHv3 0/4] First set of improvements to git-svn user doc
2009-07-06 22:20 ` [PATCH 0/4] First set of improvements to git-svn user doc Eric Wong
2009-07-07 13:02 ` [PATCHv2 " Yann Dirson
2009-07-07 13:22 ` [PATCH 0/4] First set of improvements to git-svn user doc Yann Dirson
@ 2009-07-07 20:22 ` Yann Dirson
2009-07-07 20:22 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
2 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 20:22 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Yet another small improvement wrt the "make formatting more
consistent" patch, related to the formatting of flags for the
recently-introduced 'reset' command, as well as those of 'log' I had
missed.
Yann Dirson (4):
git-svn.txt: stop using dash-form of commands.
git-svn.txt: make formatting more consistent.
git-svn.txt: fix fetch flags incorrectly documented as init flags.
git-svn.txt: fix description of fetch flags accepted by clone.
Documentation/git-svn.txt | 350 ++++++++++++++++++++++-----------------------
1 files changed, 171 insertions(+), 179 deletions(-)
^ permalink raw reply [flat|nested] 17+ messages in thread
* [PATCH 1/4] git-svn.txt: stop using dash-form of commands.
2009-07-07 20:22 ` [PATCHv3 " Yann Dirson
@ 2009-07-07 20:22 ` Yann Dirson
2009-07-07 20:22 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 20:22 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Also consistently use single quotes around git commands to make things clear
(was only needed at a couple of places).
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
Documentation/git-svn.txt | 120 ++++++++++++++++++++++----------------------
1 files changed, 60 insertions(+), 60 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 7e9b9a0..2818bcc 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -11,11 +11,11 @@ SYNOPSIS
DESCRIPTION
-----------
-'git-svn' is a simple conduit for changesets between Subversion and git.
+'git svn' is a simple conduit for changesets between Subversion and git.
It provides a bidirectional flow of changes between a Subversion and a git
repository.
-'git-svn' can track a standard Subversion repository,
+'git svn' can track a standard Subversion repository,
following the common "trunk/branches/tags" layout, with the --stdlayout option.
It can also follow branches and tags in any layout with the -T/-t/-b options
(see options to 'init' below, and also the 'clone' command).
@@ -30,7 +30,7 @@ COMMANDS
'init'::
Initializes an empty git repository with additional
- metadata directories for 'git-svn'. The Subversion URL
+ metadata directories for 'git svn'. The Subversion URL
may be specified as a command-line argument, or as full
URL arguments to -T/-t/-b. Optionally, the target
directory to operate on can be specified as a second
@@ -100,7 +100,7 @@ COMMANDS
--localtime;;
Store Git commit times in the local timezone instead of UTC. This
- makes 'git-log' (even without --date=local) show the same times
+ makes 'git log' (even without --date=local) show the same times
that `svn log` would in the local timezone.
--parent;;
@@ -148,20 +148,20 @@ Examples:
This fetches revisions from the SVN parent of the current HEAD
and rebases the current (uncommitted to SVN) work against it.
-This works similarly to `svn update` or 'git-pull' except that
-it preserves linear history with 'git-rebase' instead of
-'git-merge' for ease of dcommitting with 'git-svn'.
+This works similarly to `svn update` or 'git pull' except that
+it preserves linear history with 'git rebase' instead of
+'git merge' for ease of dcommitting with 'git svn'.
-This accepts all options that 'git-svn fetch' and 'git-rebase'
+This accepts all options that 'git svn fetch' and 'git rebase'
accept. However, '--fetch-all' only fetches from the current
[svn-remote], and not all [svn-remote] definitions.
-Like 'git-rebase'; this requires that the working tree be clean
+Like 'git rebase'; this requires that the working tree be clean
and have no uncommitted changes.
-l;;
--local;;
- Do not fetch remotely; only run 'git-rebase' against the
+ Do not fetch remotely; only run 'git rebase' against the
last fetched commit from the upstream SVN.
'dcommit'::
@@ -169,11 +169,11 @@ and have no uncommitted changes.
repository, and then rebase or reset (depending on whether or
not there is a diff between SVN and head). This will create
a revision in SVN for each commit in git.
- It is recommended that you run 'git-svn' fetch and rebase (not
+ It is recommended that you run 'git svn' fetch and rebase (not
pull or merge) your commits against the latest changes in the
SVN repository.
An optional revision or branch argument may be specified, and
- causes 'git-svn' to do all work on that revision/branch
+ causes 'git svn' to do all work on that revision/branch
instead of HEAD.
This is advantageous over 'set-tree' (below) because it produces
cleaner, more linear history.
@@ -182,7 +182,7 @@ and have no uncommitted changes.
After committing, do not rebase or reset.
--commit-url <URL>;;
Commit to this SVN URL (the full path). This is intended to
- allow existing git-svn repositories created with one transport
+ allow existing 'git svn' repositories created with one transport
method (e.g. `svn://` or `http://` for anonymous read) to be
reused if a user is later given access to an alternate transport
method (e.g. `svn+ssh://` or `https://`) for commit.
@@ -258,7 +258,7 @@ NOTE: SVN itself only stores times in UTC and nothing else. The regular svn
client converts the UTC time to the local time (or based on the TZ=
environment). This command has the same behaviour.
+
-Any other arguments are passed directly to 'git-log'
+Any other arguments are passed directly to 'git log'
'blame'::
Show what revision and author last modified each line of a file. The
@@ -266,10 +266,10 @@ Any other arguments are passed directly to 'git-log'
`svn blame' by default. Like the SVN blame command,
local uncommitted changes in the working copy are ignored;
the version of the file in the HEAD revision is annotated. Unknown
- arguments are passed directly to 'git-blame'.
+ arguments are passed directly to 'git blame'.
+
--git-format;;
- Produce output in the same format as 'git-blame', but with
+ Produce output in the same format as 'git blame', but with
SVN revision numbers instead of git commit hashes. In this mode,
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
@@ -288,7 +288,7 @@ Any other arguments are passed directly to 'git-log'
absolutely no attempts to do patching when committing to SVN, it
simply overwrites files with those specified in the tree or
commit. All merging is assumed to have taken place
- independently of 'git-svn' functions.
+ independently of 'git svn' functions.
'create-ignore'::
Recursively finds the svn:ignore property on directories and
@@ -303,12 +303,12 @@ Any other arguments are passed directly to 'git-log'
'commit-diff'::
Commits the diff of two tree-ish arguments from the
- command-line. This command does not rely on being inside an `git-svn
+ command-line. This command does not rely on being inside an `git svn
init`-ed repository. This command takes three arguments, (a) the
original tree to diff against, (b) the new tree result, (c) the
URL of the target Subversion repository. The final argument
- (URL) may be omitted if you are working from a 'git-svn'-aware
- repository (that has been `init`-ed with 'git-svn').
+ (URL) may be omitted if you are working from a 'git svn'-aware
+ repository (that has been `init`-ed with 'git svn').
The -r<revision> option is required for this.
'info'::
@@ -342,7 +342,7 @@ Any other arguments are passed directly to 'git-log'
way to repair the repo is to use 'reset'.
Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset'
-with a 'fetch' and then 'git-reset' or 'git-rebase' to move local
+with a 'fetch' and then 'git reset' or 'git rebase' to move local
branches onto the new tree.
-r/--revision=<n>;;
@@ -373,8 +373,8 @@ git svn fetch
r2---r3---A---B master
------------
-Then fixup "master" with 'git-rebase'.
-Do NOT use 'git-merge' or your history will not be compatible with a
+Then fixup "master" with 'git rebase'.
+Do NOT use 'git merge' or your history will not be compatible with a
future 'dcommit'!
[verse]
@@ -396,7 +396,7 @@ OPTIONS
--shared[={false|true|umask|group|all|world|everybody}]::
--template=<template_directory>::
Only used with the 'init' command.
- These are passed directly to 'git-init'.
+ These are passed directly to 'git init'.
-r <ARG>::
--revision <ARG>::
@@ -418,7 +418,7 @@ Only used with the 'set-tree' command.
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
-'git-rev-list --pretty=oneline' output can be used.
+'git rev-list --pretty=oneline' output can be used.
--rmdir::
@@ -448,7 +448,7 @@ config key: svn.edit
Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-They are both passed directly to 'git-diff-tree'; see
+They are both passed directly to 'git diff-tree'; see
linkgit:git-diff-tree[1] for more information.
[verse]
@@ -458,16 +458,16 @@ config key: svn.findcopiesharder
-A<filename>::
--authors-file=<filename>::
-Syntax is compatible with the file used by 'git-cvsimport':
+Syntax is compatible with the file used by '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'
+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
+appropriate entry. Re-running the previous 'git svn' command
after the authors-file is modified should continue operation.
config key: svn.authorsfile
@@ -482,7 +482,7 @@ the authors file.
-q::
--quiet::
- Make 'git-svn' less verbose. Specify a second time to make it
+ Make 'git svn' less verbose. Specify a second time to make it
even less verbose.
--repack[=<n>]::
@@ -495,7 +495,7 @@ with many revisions.
to fetch before repacking. This defaults to repacking every
1000 commits fetched if no argument is specified.
---repack-flags are passed directly to 'git-repack'.
+--repack-flags are passed directly to 'git repack'.
[verse]
config key: svn.repack
@@ -508,8 +508,8 @@ config key: svn.repackflags
These are only used with the 'dcommit' and 'rebase' commands.
-Passed directly to 'git-rebase' when using 'dcommit' if a
-'git-reset' cannot be used (see 'dcommit').
+Passed directly to 'git rebase' when using 'dcommit' if a
+'git reset' cannot be used (see 'dcommit').
-n::
--dry-run::
@@ -566,18 +566,18 @@ svn-remote.<name>.noMetadata::
This gets rid of the 'git-svn-id:' lines at the end of every commit.
-If you lose your .git/svn/git-svn/.rev_db file, 'git-svn' will not
+If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not
be able to rebuild it and you won't be able to fetch again,
either. This is fine for one-shot imports.
-The 'git-svn log' command will not work on repositories using
+The 'git svn log' command will not work on repositories using
this, either. Using this conflicts with the 'useSvmProps'
option for (hopefully) obvious reasons.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
-This allows 'git-svn' to re-map repository URLs and UUIDs from
+This allows 'git svn' to re-map repository URLs and UUIDs from
mirrors created using SVN::Mirror (or svk) for metadata.
If an SVN revision has a property, "svm:headrev", it is likely
@@ -596,7 +596,7 @@ svn-remote.<name>.useSvnsyncprops::
svn-remote.<name>.rewriteRoot::
This allows users to create repositories from alternate
- URLs. For example, an administrator could run 'git-svn' on the
+ URLs. For example, an administrator could run 'git svn' on the
server locally (accessing via file://) but wish to distribute
the repository with a public http:// or svn:// URL in the
metadata so users of it will see the public URL.
@@ -605,14 +605,14 @@ svn.brokenSymlinkWorkaround::
This disables potentially expensive checks to workaround broken symlinks
checked into SVN by broken clients. Set this option to "false" if you
track a SVN repository with many empty blobs that are not symlinks.
-This option may be changed while "git-svn" is running and take effect on
-the next revision fetched. If unset, git-svn assumes this option to be
+This option may be changed while 'git svn' is running and take effect on
+the next revision fetched. If unset, 'git svn' assumes this option to be
"true".
--
Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
-options all affect the metadata generated and used by 'git-svn'; they
+options all affect the metadata generated and used by 'git svn'; they
*must* be set in the configuration file before any history is imported
and these settings should never be changed once they are set.
@@ -630,7 +630,7 @@ Tracking and contributing to the trunk of a Subversion-managed project:
git svn clone http://svn.example.com/project/trunk
# Enter the newly cloned directory:
cd trunk
-# You should be on master branch, double-check with git-branch
+# You should be on master branch, double-check with 'git branch'
git branch
# Do some work and commit locally to git:
git commit ...
@@ -661,12 +661,12 @@ Tracking and contributing to an entire Subversion-managed project
# of dcommit/rebase/show-ignore should be the same as above.
------------------------------------------------------------------------
-The initial 'git-svn clone' can be quite time-consuming
+The initial 'git svn clone' can be quite time-consuming
(especially for large Subversion repositories). If multiple
people (or one person with multiple machines) want to use
-'git-svn' to interact with the same Subversion repository, you can
-do the initial 'git-svn clone' to a repository on a server and
-have each person clone that repository with 'git-clone':
+'git svn' to interact with the same Subversion repository, you can
+do the initial 'git svn clone' to a repository on a server and
+have each person clone that repository with 'git clone':
------------------------------------------------------------------------
# Do the initial import on a server
@@ -680,7 +680,7 @@ have each person clone that repository with 'git-clone':
git fetch
# Create a local branch from one of the branches just fetched
git checkout -b master FETCH_HEAD
-# Initialize git-svn locally (be sure to use the same URL and -T/-b/-t options as were used on server)
+# Initialize 'git svn' locally (be sure to use the same URL and -T/-b/-t options as were used on server)
git svn init http://svn.example.com/project
# Pull the latest changes from Subversion
git svn rebase
@@ -689,7 +689,7 @@ have each person clone that repository with 'git-clone':
REBASE VS. PULL/MERGE
---------------------
-Originally, 'git-svn' recommended that the 'remotes/git-svn' branch be
+Originally, 'git svn' recommended that the 'remotes/git-svn' branch be
pulled or merged from. This is because the author favored
`git svn set-tree B` to commit a single head rather than the
`git svn set-tree A..B` notation to commit multiple commits.
@@ -704,7 +704,7 @@ previous commits in SVN.
DESIGN PHILOSOPHY
-----------------
Merge tracking in Subversion is lacking and doing branched development
-with Subversion can be cumbersome as a result. While 'git-svn' can track
+with Subversion can be cumbersome as a result. While 'git svn' can track
copy history (including branches and tags) for repositories adopting a
standard layout, it cannot yet represent merge history that happened
inside git back upstream to SVN users. Therefore it is advised that
@@ -715,25 +715,25 @@ CAVEATS
-------
For the sake of simplicity and interoperating with a less-capable system
-(SVN), it is recommended that all 'git-svn' users clone, fetch and dcommit
-directly from the SVN server, and avoid all 'git-clone'/'pull'/'merge'/'push'
+(SVN), it is recommended that all 'git svn' users clone, fetch and dcommit
+directly from the SVN server, and avoid all 'git clone'/'pull'/'merge'/'push'
operations between git repositories and branches. The recommended
method of exchanging code between git branches and users is
-'git-format-patch' and 'git-am', or just 'dcommit'ing to the SVN repository.
+'git format-patch' and 'git am', or just 'dcommit'ing to the SVN repository.
-Running 'git-merge' or 'git-pull' is NOT recommended on a branch you
+Running 'git merge' or 'git pull' is NOT recommended on a branch you
plan to 'dcommit' from. Subversion does not represent merges in any
reasonable or useful fashion; so users using Subversion cannot see any
merges you've made. Furthermore, if you merge or pull from a git branch
that is a mirror of an SVN branch, 'dcommit' may commit to the wrong
branch.
-'git-clone' does not clone branches under the refs/remotes/ hierarchy or
-any 'git-svn' metadata, or config. So repositories created and managed with
-using 'git-svn' should use 'rsync' for cloning, if cloning is to be done
+'git clone' does not clone branches under the refs/remotes/ hierarchy or
+any 'git svn' metadata, or config. So repositories created and managed with
+using 'git svn' should use 'rsync' for cloning, if cloning is to be done
at all.
-Since 'dcommit' uses rebase internally, any git branches you 'git-push' to
+Since 'dcommit' uses rebase internally, any git branches you 'git push' to
before 'dcommit' on will require forcing an overwrite of the existing ref
on the remote repository. This is generally considered bad practice,
see the linkgit:git-push[1] documentation for details.
@@ -743,7 +743,7 @@ already dcommitted. It is considered bad practice to --amend commits
you've already pushed to a remote repository for other users, and
dcommit with SVN is analogous to that.
-When using multiple --branches or --tags, 'git-svn' does not automatically
+When using multiple --branches or --tags, 'git svn' does not automatically
handle name collisions (for example, if two branches from different paths have
the same name, or if a branch and a tag have the same name). In these cases,
use 'init' to set up your git repository then, before your first 'fetch', edit
@@ -769,7 +769,7 @@ for git to detect them.
CONFIGURATION
-------------
-'git-svn' stores [svn-remote] configuration information in the
+'git svn' stores [svn-remote] configuration information in the
repository .git/config file. It is similar the core git
[remote] sections except 'fetch' keys do not accept glob
arguments; but they are instead handled by the 'branches'
@@ -790,7 +790,7 @@ Keep in mind that the '\*' (asterisk) wildcard of the local ref
however the remote wildcard may be anywhere as long as it's an
independent path component (surrounded by '/' or EOL). This
type of configuration is not automatically created by 'init' and
-should be manually entered with a text-editor or using 'git-config'.
+should be manually entered with a text-editor or using 'git config'.
SEE ALSO
--------
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 2/4] git-svn.txt: make formatting more consistent.
2009-07-07 20:22 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
@ 2009-07-07 20:22 ` Yann Dirson
2009-07-07 20:22 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 20:22 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
- correctly link paragraphs within list items
- consistently format examples
- put option alernatives on separate lines
- always use [verse] for config items
- always indent 1st paragraph of a list item, with a tab
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
Documentation/git-svn.txt | 211 +++++++++++++++++++++-----------------------
1 files changed, 101 insertions(+), 110 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index 2818bcc..f40fd42 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -26,7 +26,6 @@ Subversion updated from git by the 'dcommit' command.
COMMANDS
--------
---
'init'::
Initializes an empty git repository with additional
@@ -105,7 +104,7 @@ COMMANDS
--parent;;
Fetch only from the SVN parent of the current HEAD.
-
++
This doesn't interfere with interoperating with the Subversion
repository you cloned from, but if you wish for your local Git
repository to be able to interoperate with someone else's local Git
@@ -118,20 +117,28 @@ the same local timezone.
The '--ignore-paths' option should match for every 'fetch'
(including automatic fetches due to 'clone', 'dcommit',
'rebase', etc) on a given repository.
-
++
+[verse]
config key: svn-remote.<name>.ignore-paths
-
- If the ignore-paths config key is set and the command
- line option is also given, both regular expressions
- will be used.
-
++
+If the ignore-paths config key is set and the command line option is
+also given, both regular expressions will be used.
++
Examples:
++
+--
+Skip "doc*" directory for every fetch;;
++
+------------------------------------------------------------------------
+--ignore-paths="^doc"
+------------------------------------------------------------------------
- --ignore-paths="^doc" - skip "doc*" directory for every
- fetch.
-
- --ignore-paths="^[^/]+/(?:branches|tags)" - skip
- "branches" and "tags" of first level directories.
+Skip "branches" and "tags" of first level directories;;
++
+------------------------------------------------------------------------
+--ignore-paths="^[^/]+/(?:branches|tags)"
+------------------------------------------------------------------------
+--
'clone'::
Runs 'init' and 'fetch'. It will automatically create a
@@ -147,15 +154,15 @@ Examples:
'rebase'::
This fetches revisions from the SVN parent of the current HEAD
and rebases the current (uncommitted to SVN) work against it.
-
++
This works similarly to `svn update` or 'git pull' except that
it preserves linear history with 'git rebase' instead of
'git merge' for ease of dcommitting with 'git svn'.
-
++
This accepts all options that 'git svn fetch' and 'git rebase'
accept. However, '--fetch-all' only fetches from the current
[svn-remote], and not all [svn-remote] definitions.
-
++
Like 'git rebase'; this requires that the working tree be clean
and have no uncommitted changes.
@@ -186,14 +193,13 @@ and have no uncommitted changes.
method (e.g. `svn://` or `http://` for anonymous read) to be
reused if a user is later given access to an alternate transport
method (e.g. `svn+ssh://` or `https://`) for commit.
-
++
+[verse]
config key: svn-remote.<name>.commiturl
-
config key: svn.commiturl (overwrites all svn-remote.<name>.commiturl options)
-
- Using this option for any other purpose (don't ask)
- is very strongly discouraged.
---
++
+Using this option for any other purpose (don't ask) is very strongly
+discouraged.
'branch'::
Create a branch in the SVN repository.
@@ -232,10 +238,12 @@ where <name> is the name of the SVN repository as specified by the -R option to
The following features from `svn log' are supported:
+
--
--r/--revision=<n>[:<n>];;
+-r <n>[:<n>];;
+--revision=<n>[:<n>];;
is supported, non-numeric args are not:
HEAD, NEXT, BASE, PREV, etc ...
--v/--verbose;;
+-v;;
+--verbose;;
it's not completely compatible with the --verbose
output in svn log, but reasonably close.
--limit=<n>;;
@@ -274,7 +282,6 @@ Any other arguments are passed directly to 'git log'
changes that haven't been committed to SVN (including local
working-copy edits) are shown as revision 0.
---
'find-rev'::
When given an SVN revision number of the form 'rN', returns the
corresponding git commit hash (this can optionally be followed by a
@@ -340,58 +347,56 @@ Any other arguments are passed directly to 'git log'
"checksum mismatch" (missed a modification). If the problem
file cannot be ignored forever (with --ignore-paths) the only
way to repair the repo is to use 'reset'.
-
++
Only the rev_map and refs/remotes/git-svn are changed. Follow 'reset'
with a 'fetch' and then 'git reset' or 'git rebase' to move local
branches onto the new tree.
--r/--revision=<n>;;
+-r <n>;;
+--revision=<n>;;
Specify the most recent revision to keep. All later revisions
are discarded.
--p/--parent;;
+-p;;
+--parent;;
Discard the specified revision as well, keeping the nearest
parent instead.
Example:;;
Assume you have local changes in "master", but you need to refetch "r2".
-
++
------------
r1---r2---r3 remotes/git-svn
\
A---B master
------------
-
++
Fix the ignore-paths or SVN permissions problem that caused "r2" to
be incomplete in the first place. Then:
-
++
[verse]
git svn reset -r2 -p
git svn fetch
-
++
------------
r1---r2'--r3' remotes/git-svn
\
r2---r3---A---B master
------------
-
++
Then fixup "master" with 'git rebase'.
Do NOT use 'git merge' or your history will not be compatible with a
future 'dcommit'!
-
++
[verse]
git rebase --onto remotes/git-svn A^ master
-
++
------------
r1---r2'--r3' remotes/git-svn
\
A'--B' master
------------
-
---
-
OPTIONS
-------
---
--shared[={false|true|umask|group|all|world|everybody}]::
--template=<template_directory>::
@@ -400,85 +405,81 @@ OPTIONS
-r <ARG>::
--revision <ARG>::
-
-Used with the 'fetch' command.
-
+ Used with the 'fetch' command.
++
This allows revision ranges for partial/cauterized history
to be supported. $NUMBER, $NUMBER1:$NUMBER2 (numeric ranges),
$NUMBER:HEAD, and BASE:$NUMBER are all supported.
-
++
This can allow you to make partial mirrors when running fetch;
but is generally not recommended because history will be skipped
and lost.
-::
--stdin::
-
-Only used with the 'set-tree' command.
-
+ Only used with the 'set-tree' command.
++
Read a list of commits from stdin and commit them in reverse
order. Only the leading sha1 is read from each line, so
'git rev-list --pretty=oneline' output can be used.
--rmdir::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
Remove directories from the SVN tree if there are no files left
behind. SVN can version empty directories, and they are not
removed by default if there are no files left in them. git
cannot version empty directories. Enabling this flag will make
the commit to SVN act like git.
-
++
+[verse]
config key: svn.rmdir
-e::
--edit::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
Edit the commit message before committing to SVN. This is off by
default for objects that are commits, and forced on when committing
tree objects.
-
++
+[verse]
config key: svn.edit
-l<num>::
--find-copies-harder::
-
-Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
-
+ Only used with the 'dcommit', 'set-tree' and 'commit-diff' commands.
++
They are both passed directly to 'git diff-tree'; see
linkgit:git-diff-tree[1] for more information.
-
++
[verse]
config key: svn.l
config key: svn.findcopiesharder
-A<filename>::
--authors-file=<filename>::
-
-Syntax is compatible with the file used by 'git cvsimport':
-
+ Syntax is compatible with the file used by '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.
-
++
+[verse]
config key: svn.authorsfile
--authors-prog=<filename>::
-
-If this option is specified, for each SVN committer name that does not
-exist in the authors file, the given file is executed with the committer
-name as the first argument. The program is expected to return a single
-line of the form "Name <email>", which will be treated as if included in
-the authors file.
+ If this option is specified, for each SVN committer name that
+ does not exist in the authors file, the given file is executed
+ with the committer name as the first argument. The program is
+ expected to return a single line of the form "Name <email>",
+ which will be treated as if included in the authors file.
-q::
--quiet::
@@ -487,16 +488,15 @@ the authors file.
--repack[=<n>]::
--repack-flags=<flags>::
-
-These should help keep disk usage sane for large fetches
-with many revisions.
-
+ These should help keep disk usage sane for large fetches with
+ many revisions.
++
--repack takes an optional argument for the number of revisions
to fetch before repacking. This defaults to repacking every
1000 commits fetched if no argument is specified.
-
++
--repack-flags are passed directly to 'git repack'.
-
++
[verse]
config key: svn.repack
config key: svn.repackflags
@@ -505,41 +505,36 @@ config key: svn.repackflags
--merge::
-s<strategy>::
--strategy=<strategy>::
-
-These are only used with the 'dcommit' and 'rebase' commands.
-
+ These are only used with the 'dcommit' and 'rebase' commands.
++
Passed directly to 'git rebase' when using 'dcommit' if a
'git reset' cannot be used (see 'dcommit').
-n::
--dry-run::
-
-This can be used with the 'dcommit', 'rebase', 'branch' and 'tag'
-commands.
-
+ This can be used with the 'dcommit', 'rebase', 'branch' and
+ 'tag' commands.
++
For 'dcommit', print out the series of git arguments that would show
which diffs would be committed to SVN.
-
++
For 'rebase', display the local branch associated with the upstream svn
repository associated with the current branch and the URL of svn
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.
---
ADVANCED OPTIONS
----------------
---
-i<GIT_SVN_ID>::
--id <GIT_SVN_ID>::
-
-This sets GIT_SVN_ID (instead of using the environment). This
-allows the user to override the default refname to fetch from
-when tracking a single URL. The 'log' and 'dcommit' commands
-no longer require this switch as an argument.
+ This sets GIT_SVN_ID (instead of using the environment). This
+ allows the user to override the default refname to fetch from
+ when tracking a single URL. The 'log' and 'dcommit' commands
+ no longer require this switch as an argument.
-R<remote name>::
--svn-remote <remote name>::
@@ -553,33 +548,30 @@ no longer require this switch as an argument.
started tracking a branch and never tracked the trunk it was
descended from. This feature is enabled by default, use
--no-follow-parent to disable it.
-
++
+[verse]
config key: svn.followparent
---
CONFIG FILE-ONLY OPTIONS
------------------------
---
svn.noMetadata::
svn-remote.<name>.noMetadata::
-
-This gets rid of the 'git-svn-id:' lines at the end of every commit.
-
+ This gets rid of the 'git-svn-id:' lines at the end of every commit.
++
If you lose your .git/svn/git-svn/.rev_db file, 'git svn' will not
be able to rebuild it and you won't be able to fetch again,
either. This is fine for one-shot imports.
-
++
The 'git svn log' command will not work on repositories using
this, either. Using this conflicts with the 'useSvmProps'
option for (hopefully) obvious reasons.
svn.useSvmProps::
svn-remote.<name>.useSvmProps::
-
-This allows 'git svn' to re-map repository URLs and UUIDs from
-mirrors created using SVN::Mirror (or svk) for metadata.
-
+ This allows 'git svn' to re-map repository URLs and UUIDs from
+ mirrors created using SVN::Mirror (or svk) for metadata.
++
If an SVN revision has a property, "svm:headrev", it is likely
that the revision was created by SVN::Mirror (also used by SVK).
The property contains a repository UUID and a revision. We want
@@ -602,14 +594,13 @@ svn-remote.<name>.rewriteRoot::
metadata so users of it will see the public URL.
svn.brokenSymlinkWorkaround::
-This disables potentially expensive checks to workaround broken symlinks
-checked into SVN by broken clients. Set this option to "false" if you
-track a SVN repository with many empty blobs that are not symlinks.
-This option may be changed while 'git svn' is running and take effect on
-the next revision fetched. If unset, 'git svn' assumes this option to be
-"true".
-
---
+ This disables potentially expensive checks to workaround
+ broken symlinks checked into SVN by broken clients. Set this
+ option to "false" if you track a SVN repository with many
+ empty blobs that are not symlinks. This option may be changed
+ while 'git svn' is running and take effect on the next
+ revision fetched. If unset, 'git svn' assumes this option to
+ be "true".
Since the noMetadata, rewriteRoot, useSvnsyncProps and useSvmProps
options all affect the metadata generated and used by 'git svn'; they
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags.
2009-07-07 20:22 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
@ 2009-07-07 20:22 ` Yann Dirson
2009-07-07 20:22 ` [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone Yann Dirson
0 siblings, 1 reply; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 20:22 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
Documentation/git-svn.txt | 21 +++++++++++----------
1 files changed, 11 insertions(+), 10 deletions(-)
diff --git a/Documentation/git-svn.txt b/Documentation/git-svn.txt
index f40fd42..1e8242b 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -62,16 +62,6 @@ COMMANDS
Set the 'useSvnsyncProps' option in the [svn-remote] config.
--rewrite-root=<URL>;;
Set the 'rewriteRoot' option in the [svn-remote] config.
---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.
--username=<USER>;;
For transports that SVN handles authentication for (http,
https, and plain svn), specify the username. For other
@@ -140,6 +130,17 @@ 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;
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
* [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone.
2009-07-07 20:22 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
@ 2009-07-07 20:22 ` Yann Dirson
0 siblings, 0 replies; 17+ messages in thread
From: Yann Dirson @ 2009-07-07 20:22 UTC (permalink / raw)
To: git; +Cc: Yann Dirson
Signed-off-by: Yann Dirson <ydirson@altern.org>
Acked-by: Eric Wong <normalperson@yhbt.net>
---
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 1e8242b..10af599 100644
--- a/Documentation/git-svn.txt
+++ b/Documentation/git-svn.txt
@@ -147,10 +147,10 @@ Skip "branches" and "tags" of first level directories;;
or if a second argument is passed; it will create a directory
and work within that. It accepts all arguments that the
'init' and 'fetch' commands accept; with the exception of
- '--fetch-all'. After a repository is cloned, the 'fetch'
- command will be able to update revisions without affecting
- the working tree; and the 'rebase' command will be able
- to update the working tree with the latest changes.
+ '--fetch-all' and '--parent'. After a repository is cloned,
+ the 'fetch' command will be able to update revisions without
+ affecting the working tree; and the 'rebase' command will be
+ able to update the working tree with the latest changes.
'rebase'::
This fetches revisions from the SVN parent of the current HEAD
--
1.6.3.3
^ permalink raw reply related [flat|nested] 17+ messages in thread
end of thread, other threads:[~2009-07-07 20:27 UTC | newest]
Thread overview: 17+ messages (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2009-07-05 22:03 [PATCH 0/4] First set of improvements to git-svn user doc Yann Dirson
2009-07-05 22:03 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
2009-07-05 22:03 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
2009-07-05 22:03 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
2009-07-05 22:03 ` [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone Yann Dirson
2009-07-06 22:20 ` [PATCH 0/4] First set of improvements to git-svn user doc Eric Wong
2009-07-07 13:02 ` [PATCHv2 " Yann Dirson
2009-07-07 13:02 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
2009-07-07 13:02 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
2009-07-07 13:02 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
2009-07-07 13:02 ` [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone Yann Dirson
2009-07-07 13:22 ` [PATCH 0/4] First set of improvements to git-svn user doc Yann Dirson
2009-07-07 20:22 ` [PATCHv3 " Yann Dirson
2009-07-07 20:22 ` [PATCH 1/4] git-svn.txt: stop using dash-form of commands Yann Dirson
2009-07-07 20:22 ` [PATCH 2/4] git-svn.txt: make formatting more consistent Yann Dirson
2009-07-07 20:22 ` [PATCH 3/4] git-svn.txt: fix fetch flags incorrectly documented as init flags Yann Dirson
2009-07-07 20:22 ` [PATCH 4/4] git-svn.txt: fix description of fetch flags accepted by clone Yann Dirson
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).