From: Junio C Hamano Date: Thu, 12 Oct 2006 04:07:40 +0000 (+0000) Subject: Autogenerated man pages for v1.4.3-rc2-g83e9 X-Git-Url: http://git.tremily.us/?a=commitdiff_plain;h=d0f970bacc299afb70574fee148f0b05daf9cdfe;p=git.git Autogenerated man pages for v1.4.3-rc2-g83e9 --- diff --git a/man1/git-svn.1 b/man1/git-svn.1 index b97560853..c8af0c69e 100755 --- a/man1/git-svn.1 +++ b/man1/git-svn.1 @@ -2,7 +2,7 @@ .\" It was generated using the DocBook XSL Stylesheets (version 1.69.1). .\" Instead of manually editing it, you probably should edit the DocBook XML .\" source for it and then use the DocBook XSL Stylesheets to regenerate it. -.TH "GIT\-SVN" "1" "10/03/2006" "" "" +.TH "GIT\-SVN" "1" "10/12/2006" "" "" .\" disable hyphenation .nh .\" disable justification (adjust text to left margin only) @@ -24,7 +24,7 @@ git\-svn mostly ignores the very limited view of branching that Subversion has. .SH "COMMANDS" .TP \fIinit\fR -Creates an empty git repository with additional metadata directories for git\-svn. The Subversion URL must be specified as a command\-line argument. +Creates an empty git repository with additional metadata directories for git\-svn. The Subversion URL must be specified as a command\-line argument. Optionally, the target directory to operate on can be specified as a second argument. Normally this command initializes the current directory. .TP \fIfetch\fR Fetch unfetched revisions from the Subversion URL we are tracking. refs/remotes/git\-svn will be updated to the latest revision. @@ -42,8 +42,41 @@ Commit all diffs from the current HEAD directly to the SVN repository, and then \fIcommit\fR (below) because it produces cleaner, more linear history. .TP +\fIlog\fR +This should make it easy to look up svn log messages when svn users refer to \-r/\-\-revision numbers. +.sp +.nf +The following features from `svn log' are supported: +.fi +.sp +.nf +\-\-revision=[:] \- is supported, non\-numeric args are not: + HEAD, NEXT, BASE, PREV, etc ... +\-v/\-\-verbose \- it's not completely compatible with + the \-\-verbose output in svn log, but + reasonably close. +\-\-limit= \- is NOT the same as \-\-max\-count, + doesn't count merged/excluded commits +\-\-incremental \- supported +.fi +.sp +.nf +New features: +.fi +.sp +.nf +\-\-show\-commit \- shows the git commit sha1, as well +\-\-oneline \- our version of \-\-pretty=oneline +.fi +.sp +.nf +Any other arguments are passed directly to `git log' +.fi +.TP \fIcommit\fR -Commit specified commit or tree objects to SVN. This relies on your imported fetch data being up\-to\-date. This makes 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. +You should consider using +\fIdcommit\fR +instead of this command. Commit specified commit or tree objects to SVN. This relies on your imported fetch data being up\-to\-date. This makes 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. .TP \fIrebuild\fR Not a part of daily usage, but this is a useful command if you've just cloned a repository (using @@ -51,8 +84,26 @@ Not a part of daily usage, but this is a useful command if you've just cloned a .TP \fIshow\-ignore\fR Recursively finds and lists the svn:ignore property on directories. The output is suitable for appending to the $GIT_DIR/info/exclude file. +.TP +\fIcommit\-diff\fR +Commits the diff of two tree\-ish arguments from the command\-line. This command is intended for interopability with git\-svnimport and 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). +.TP +\fIgraft\-branches\fR +This command attempts to detect merges/branches from already imported history. Techniques used currently include regexes, file copies, and tree\-matches). This command generates (or modifies) the $GIT_DIR/info/grafts file. This command is considered experimental, and inherently flawed because merge\-tracking in SVN is inherently flawed and inconsistent across different repositories. +.TP +\fImulti\-init\fR +This command supports git\-svnimport\-like command\-line syntax for importing repositories that are layed out as recommended by the SVN folks. This is a bit more tolerant than the git\-svnimport command\-line syntax and doesn't require the user to figure out where the repository URL ends and where the repository path begins. +.TP +\fImulti\-fetch\fR +This runs fetch on all known SVN branches we're tracking. This will NOT discover new branches (unlike git\-svnimport), so multi\-init will need to be re\-run (it's idempotent). .SH "OPTIONS" .TP +\-\-shared , \-\-template= +Only used with the +\fIinit\fR +command. These are passed directly to +\fBgit\-init\-db\fR(1). +.TP \-r , \-\-revision Only used with the \fIfetch\fR @@ -71,8 +122,11 @@ Read a list of commits from stdin and commit them in reverse order. Only the lea .TP \-\-rmdir Only used with the +\fIdcommit\fR, \fIcommit\fR -command. +and +\fIcommit\-diff\fR +commands. .sp 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. .sp @@ -80,17 +134,23 @@ repo\-config key: svn.rmdir .TP \-e , \-\-edit Only used with the +\fIdcommit\fR, \fIcommit\fR -command. +and +\fIcommit\-diff\fR +commands. .sp 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. .sp repo\-config key: svn.edit .TP \-l , \-\-find\-copies\-harder -Both of these are only used with the +Only used with the +\fIdcommit\fR, \fIcommit\fR -command. +and +\fIcommit\-diff\fR +commands. .sp They are both passed directly to git\-diff\-tree see \fBgit\-diff\-tree\fR(1) @@ -109,7 +169,24 @@ Syntax is compatible with the files used by git\-svnimport and git\-cvsimport: .fi 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. .sp -repo\-config key: svn.authors\-file +repo\-config key: svn.authorsfile +.TP +\-q , \-\-quiet +Make git\-svn less verbose. This only affects git\-svn if you have the SVN::* libraries installed and are using them. +.TP +\-\-repack[=] +\-\-repack\-flags= These should help keep disk usage sane for large fetches with many revisions. +.sp +.nf +\-\-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. +.fi +.sp +.nf +\-\-repack\-flags are passed directly to gitlink:git\-repack[1]. +.fi +repo\-config key: svn.repack repo\-config key: svn.repackflags .TP \-m , \-\-merge , \-s , \-\-strategy= These are only used with the @@ -148,6 +225,29 @@ repo\-config key: svn.branch This sets GIT_SVN_ID (instead of using the environment). See the section on \fITracking Multiple Repositories or Branches\fR for more information on using GIT_SVN_ID. +.TP +\-\-follow\-parent +This is especially helpful when we're tracking a directory that has been moved around within the repository, or if we started tracking a branch and never tracked the trunk it was descended from. +.sp +.nf +This relies on the SVN::* libraries to work. +.fi +repo\-config key: svn.followparent +.TP +\-\-no\-metadata +This gets rid of the git\-svn\-id: lines at the end of every commit. +.sp +.nf +With this, you lose the ability to use the rebuild command. If +you ever lose your .git/svn/git\-svn/.rev_db file, you won't be +able to fetch again, either. This is fine for one\-shot imports. +.fi +.sp +.nf +The 'git\-svn log' command will not work on repositories using this, +either. +.fi +repo\-config key: svn.nometadata .SH "COMPATIBILITY OPTIONS" .TP \-\-upgrade @@ -164,6 +264,8 @@ and \fIrebuild\fR command. .sp +This command has no effect when you are using the SVN::* libraries with git, svn:externals are always avoided. +.sp By default, git\-svn passes \-\-ignore\-externals to svn to avoid fetching svn:external trees into git. Pass this flag to enable externals tracking directly via git. .sp Versions of svn that do not support \-\-ignore\-externals are automatically detected and this flag will be automatically enabled for them. @@ -189,7 +291,7 @@ Tracking and contributing to an Subversion managed\-project: .sp .sp .nf -# Initialize a tree (like git init\-db): +# Initialize a repo (like git init\-db): git\-svn init http://svn.foo.org/project/trunk # Fetch remote revisions: git\-svn fetch @@ -215,7 +317,7 @@ Merge tracking in Subversion is lacking and doing branched development with Subv .SH "TRACKING MULTIPLE REPOSITORIES OR BRANCHES" This is for advanced users, most users should ignore this section. .sp -Because git\-svn does not care about relationships between different branches or directories in a Subversion repository, git\-svn has a simple hack to allow it to track an arbitrary number of related _or_ unrelated SVN repositories via one git repository. Simply set the GIT_SVN_ID environment variable to a name other other than "git\-svn" (the default) and git\-svn will ignore the contents of the $GIT_DIR/git\-svn directory and instead do all of its work in $GIT_DIR/$GIT_SVN_ID for that invocation. The interface branch will be remotes/$GIT_SVN_ID, instead of remotes/git\-svn. Any remotes/$GIT_SVN_ID branch should never be modified by the user outside of git\-svn commands. +Because git\-svn does not care about relationships between different branches or directories in a Subversion repository, git\-svn has a simple hack to allow it to track an arbitrary number of related _or_ unrelated SVN repositories via one git repository. Simply set the GIT_SVN_ID environment variable to a name other other than "git\-svn" (the default) and git\-svn will ignore the contents of the $GIT_DIR/svn/git\-svn directory and instead do all of its work in $GIT_DIR/svn/$GIT_SVN_ID for that invocation. The interface branch will be remotes/$GIT_SVN_ID, instead of remotes/git\-svn. Any remotes/$GIT_SVN_ID branch should never be modified by the user outside of git\-svn commands. .sp .SH "ADDITIONAL FETCH ARGUMENTS" This is for advanced users, most users should ignore this section. @@ -233,6 +335,8 @@ This allows you to tie unfetched SVN revision 375 to your current HEAD: git\-svn fetch 375=$(git\-rev\-parse HEAD) .fi .SS "Advanced Example: Tracking a Reorganized Repository" +Note: this example is now obsolete if you have SVN::* libraries installed. Simply use \-\-follow\-parent when fetching. +.sp If you're tracking a directory that has moved, or otherwise been branched or tagged off of another directory in the repository and you care about the full history of the project, then you can read this section. .sp This is how Yann Dirson tracked the trunk of the ufoai directory when the /trunk directory of his repository was moved to /ufoai/trunk and he needed to continue tracking /ufoai/trunk where /trunk left off. @@ -257,12 +361,10 @@ This is how Yann Dirson tracked the trunk of the ufoai directory when the /trunk 166=`git\-rev\-parse refs/remotes/git\-oldsvn` .fi .SH "BUGS" -If somebody commits a conflicting changeset to SVN at a bad moment (right before you commit) causing a conflict and your commit to fail, your svn working tree ($GIT_DIR/git\-svn/tree) may be dirtied. The easiest thing to do is probably just to rm \-rf $GIT_DIR/git\-svn/tree and run \fIrebuild\fR. +If you are not using the SVN::* Perl libraries and somebody commits a conflicting changeset to SVN at a bad moment (right before you commit) causing a conflict and your commit to fail, your svn working tree ($GIT_DIR/git\-svn/tree) may be dirtied. The easiest thing to do is probably just to rm \-rf $GIT_DIR/git\-svn/tree and run \fIrebuild\fR. .sp We ignore all SVN properties except svn:executable. Too difficult to map them since we rely heavily on git write\-tree being _exactly_ the same on both the SVN and git working trees and I prefer not to clutter working trees with metadata files. .sp -svn:keywords can't be ignored in Subversion (at least I don't know of a way to ignore them). -.sp Renamed and copied directories are not detected by git and hence not tracked when committing to SVN. I do not plan on adding support for this as it's quite difficult and time\-consuming to get working for all the possible corner cases (git doesn't do it, either). Renamed and copied files are fully supported if they're similar enough for git to detect them. .sp .SH "SEE ALSO"