From 7137280ba4456c16926bf1952787bb8b319b1ae5 Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Mon, 10 Jul 2006 08:13:00 +0000 Subject: [PATCH] Autogenerated man pages for v1.4.1-g8682 --- man1/git-diff-files.1 | 26 +++- man1/git-diff-index.1 | 26 +++- man1/git-diff-stages.1 | 26 +++- man1/git-diff-tree.1 | 26 +++- man1/git-name-rev.1 | 2 +- man1/git-repo-config.1 | 12 ++ man1/git-svn.1 | 340 +++++++++++++++++++++++++++++++++++++++++ 7 files changed, 445 insertions(+), 13 deletions(-) create mode 100755 man1/git-svn.1 diff --git a/man1/git-diff-files.1 b/man1/git-diff-files.1 index 08b17434f..10f5a959e 100755 --- a/man1/git-diff-files.1 +++ b/man1/git-diff-files.1 @@ -40,13 +40,17 @@ Generate patch (see section on generating patches) \-u Synonym for "\-p"\&. +.TP +\-\-raw +Generate the raw format\&. + .TP \-\-patch\-with\-raw -Generate patch but keep also the default raw diff output\&. +Synonym for "\-p \-\-raw"\&. .TP \-\-stat -Generate a diffstat instead of a patch\&. +Generate a diffstat\&. .TP \-\-summary @@ -54,7 +58,7 @@ Output a condensed summary of extended header information such as creations, ren .TP \-\-patch\-with\-stat -Generate patch and prepend its diffstat\&. +Synonym for "\-p \-\-stat"\&. .TP \-z @@ -68,10 +72,26 @@ Show only names of changed files\&. \-\-name\-status Show only names and status of changed files\&. +.TP +\-\-color +Show colored diff\&. + +.TP +\-\-no\-color +Turn off colored diff, even when the configuration file gives the default to color output\&. + +.TP +\-\-no\-renames +Turn off rename detection, even when the configuration file gives the default to do so\&. + .TP \-\-full\-index Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&. +.TP +\-\-binary +In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&. + .TP \-\-abbrev[=] Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=\&. diff --git a/man1/git-diff-index.1 b/man1/git-diff-index.1 index 59d545d33..60b7ff70b 100755 --- a/man1/git-diff-index.1 +++ b/man1/git-diff-index.1 @@ -40,13 +40,17 @@ Generate patch (see section on generating patches) \-u Synonym for "\-p"\&. +.TP +\-\-raw +Generate the raw format\&. + .TP \-\-patch\-with\-raw -Generate patch but keep also the default raw diff output\&. +Synonym for "\-p \-\-raw"\&. .TP \-\-stat -Generate a diffstat instead of a patch\&. +Generate a diffstat\&. .TP \-\-summary @@ -54,7 +58,7 @@ Output a condensed summary of extended header information such as creations, ren .TP \-\-patch\-with\-stat -Generate patch and prepend its diffstat\&. +Synonym for "\-p \-\-stat"\&. .TP \-z @@ -68,10 +72,26 @@ Show only names of changed files\&. \-\-name\-status Show only names and status of changed files\&. +.TP +\-\-color +Show colored diff\&. + +.TP +\-\-no\-color +Turn off colored diff, even when the configuration file gives the default to color output\&. + +.TP +\-\-no\-renames +Turn off rename detection, even when the configuration file gives the default to do so\&. + .TP \-\-full\-index Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&. +.TP +\-\-binary +In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&. + .TP \-\-abbrev[=] Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=\&. diff --git a/man1/git-diff-stages.1 b/man1/git-diff-stages.1 index 75e11c323..f66a5c1b8 100755 --- a/man1/git-diff-stages.1 +++ b/man1/git-diff-stages.1 @@ -40,13 +40,17 @@ Generate patch (see section on generating patches) \-u Synonym for "\-p"\&. +.TP +\-\-raw +Generate the raw format\&. + .TP \-\-patch\-with\-raw -Generate patch but keep also the default raw diff output\&. +Synonym for "\-p \-\-raw"\&. .TP \-\-stat -Generate a diffstat instead of a patch\&. +Generate a diffstat\&. .TP \-\-summary @@ -54,7 +58,7 @@ Output a condensed summary of extended header information such as creations, ren .TP \-\-patch\-with\-stat -Generate patch and prepend its diffstat\&. +Synonym for "\-p \-\-stat"\&. .TP \-z @@ -68,10 +72,26 @@ Show only names of changed files\&. \-\-name\-status Show only names and status of changed files\&. +.TP +\-\-color +Show colored diff\&. + +.TP +\-\-no\-color +Turn off colored diff, even when the configuration file gives the default to color output\&. + +.TP +\-\-no\-renames +Turn off rename detection, even when the configuration file gives the default to do so\&. + .TP \-\-full\-index Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&. +.TP +\-\-binary +In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&. + .TP \-\-abbrev[=] Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=\&. diff --git a/man1/git-diff-tree.1 b/man1/git-diff-tree.1 index 9fe6f0cd5..d0340d89c 100755 --- a/man1/git-diff-tree.1 +++ b/man1/git-diff-tree.1 @@ -49,13 +49,17 @@ Generate patch (see section on generating patches) \-u Synonym for "\-p"\&. +.TP +\-\-raw +Generate the raw format\&. + .TP \-\-patch\-with\-raw -Generate patch but keep also the default raw diff output\&. +Synonym for "\-p \-\-raw"\&. .TP \-\-stat -Generate a diffstat instead of a patch\&. +Generate a diffstat\&. .TP \-\-summary @@ -63,7 +67,7 @@ Output a condensed summary of extended header information such as creations, ren .TP \-\-patch\-with\-stat -Generate patch and prepend its diffstat\&. +Synonym for "\-p \-\-stat"\&. .TP \-z @@ -77,10 +81,26 @@ Show only names of changed files\&. \-\-name\-status Show only names and status of changed files\&. +.TP +\-\-color +Show colored diff\&. + +.TP +\-\-no\-color +Turn off colored diff, even when the configuration file gives the default to color output\&. + +.TP +\-\-no\-renames +Turn off rename detection, even when the configuration file gives the default to do so\&. + .TP \-\-full\-index Instead of the first handful characters, show full object name of pre\- and post\-image blob on the "index" line when generating a patch format output\&. +.TP +\-\-binary +In addition to \-\-full\-index, output "binary diff" that can be applied with "git apply"\&. + .TP \-\-abbrev[=] Instead of showing the full 40\-byte hexadecimal object name in diff\-raw format output and diff\-tree header lines, show only handful hexdigits prefix\&. This is independent of \-\-full\-index option above, which controls the diff\-patch output format\&. Non default number of digits can be specified with \-\-abbrev=\&. diff --git a/man1/git-name-rev.1 b/man1/git-name-rev.1 index 2d178a22a..f08a5068d 100755 --- a/man1/git-name-rev.1 +++ b/man1/git-name-rev.1 @@ -42,7 +42,7 @@ List all commits reachable from all refs .TP \-\-stdin -Read from stdin, append "()" to all sha1's of name'able commits, and pass to stdout +Read from stdin, append "()" to all sha1's of nameable commits, and pass to stdout .SH "EXAMPLE" diff --git a/man1/git-repo-config.1 b/man1/git-repo-config.1 index 4cc2fc5cd..6216b9d28 100755 --- a/man1/git-repo-config.1 +++ b/man1/git-repo-config.1 @@ -293,10 +293,22 @@ Command aliases for the \fBgit\fR(1) command wrapper \- e\&.g\&. after defining apply\&.whitespace Tells git\-apply how to handle whitespaces, in the same way as the \fI\-\-whitespace\fR option\&. See \fBgit\-apply\fR(1)\&. +.TP +diff\&.color +When true (or always), always use colors in patch\&. When false (or never), never\&. When set to auto, use colors only when the output is to the terminal\&. + +.TP +diff\&.color\&. +Use customized color for diff colorization\&. specifies which part of the patch to use the specified color, and is one of plain (context text), meta (metainformation), frag (hunk header), old (removed lines), or new (added lines)\&. The value for these configuration variables can be one of: normal, bold, dim, ul, blink, reverse, reset, black, red, green, yellow, blue, magenta, cyan, or white\&. + .TP diff\&.renameLimit The number of files to consider when performing the copy/rename detection; equivalent to the git diff option \fI\-l\fR\&. +.TP +diff\&.renames +Tells git to detect renames\&. If set to any boolean value, it will enable basic rename detection\&. If set to "copies" or "copy", it will detect copies, as well\&. + .TP format\&.headers Additional email headers to include in a patch to be submitted by mail\&. See \fBgit\-format\-patch\fR(1)\&. diff --git a/man1/git-svn.1 b/man1/git-svn.1 new file mode 100755 index 000000000..3ba8d385f --- /dev/null +++ b/man1/git-svn.1 @@ -0,0 +1,340 @@ +.\"Generated by db2man.xsl. Don't modify this, modify the source. +.de Sh \" Subsection +.br +.if t .Sp +.ne 5 +.PP +\fB\\$1\fR +.PP +.. +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Ip \" List item +.br +.ie \\n(.$>=3 .ne \\$3 +.el .ne 3 +.IP "\\$1" \\$2 +.. +.TH "GIT-SVN" 1 "" "" "" +.SH NAME +git-svn \- bidirectional operation between a single Subversion branch and git +.SH "SYNOPSIS" + + +\fIgit\-svn\fR [options] [arguments] + +.SH "DESCRIPTION" + + +git\-svn is a simple conduit for changesets between a single Subversion branch and git\&. + + +git\-svn is not to be confused with git\-svnimport\&. The were designed with very different goals in mind\&. + + +git\-svn is designed for an individual developer who wants a bidirectional flow of changesets between a single branch in Subversion and an arbitrary number of branches in git\&. git\-svnimport is designed for read\-only operation on repositories that match a particular layout (albeit the recommended one by SVN developers)\&. + + +For importing svn, git\-svnimport is potentially more powerful when operating on repositories organized under the recommended trunk/branch/tags structure, and should be faster, too\&. + + +git\-svn mostly ignores the very limited view of branching that Subversion has\&. This allows git\-svn to be much easier to use, especially on repositories that are not organized in a manner that git\-svnimport is designed for\&. + +.SH "COMMANDS" + +.TP +init +Creates an empty git repository with additional metadata directories for git\-svn\&. The Subversion URL must be specified as a command\-line argument\&. + +.TP +fetch +Fetch unfetched revisions from the Subversion URL we are tracking\&. refs/remotes/git\-svn will be updated to the latest revision\&. + +.nf +Note: You should never attempt to modify the remotes/git\-svn +branch outside of git\-svn\&. Instead, create a branch from +remotes/git\-svn and work on that branch\&. Use the 'commit' +command (see below) to write git commits back to +remotes/git\-svn\&. +.fi + +.nf +See 'Additional Fetch Arguments' if you are interested in +manually joining branches on commit\&. +.fi + +.TP +commit +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 +rebuild +Not a part of daily usage, but this is a useful command if you've just cloned a repository (using git\-clone) that was tracked with git\-svn\&. Unfortunately, git\-clone does not clone git\-svn metadata and the svn working tree that git\-svn uses for its operations\&. This rebuilds the metadata so git\-svn can resume fetch operations\&. A Subversion URL may be optionally specified at the command\-line if the directory/repository you're tracking has moved or changed protocols\&. + +.TP +show\-ignore +Recursively finds and lists the svn:ignore property on directories\&. The output is suitable for appending to the $GIT_DIR/info/exclude file\&. + +.SH "OPTIONS" + +.TP +\-r , \-\-revision +Only used with the \fIfetch\fR command\&. + +.nf +Takes any valid \-r svn would accept and passes it +directly to svn\&. \-r: ranges and "{" DATE "}" syntax +is also supported\&. This is passed directly to svn, see svn +documentation for more details\&. +.fi + +.nf +This can allow you to make partial mirrors when running fetch\&. +.fi + +.TP +\-, \-\-stdin +Only used with the \fIcommit\fR command\&. + +.nf +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\&. +.fi + +.TP +\-\-rmdir +Only used with the \fIcommit\fR command\&. + +.nf +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\&. +.fi + +.nf +repo\-config key: svn\&.rmdir +.fi + +.TP +\-e, \-\-edit +Only used with the \fIcommit\fR command\&. + +.nf +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\&. +.fi + +.nf +repo\-config key: svn\&.edit +.fi + +.TP +\-l, \-\-find\-copies\-harder +Both of these are only used with the \fIcommit\fR command\&. + +.nf +They are both passed directly to git\-diff\-tree see +git\-diff\-tree(1) for more information\&. +.fi + +.nf +repo\-config key: svn\&.l +repo\-config key: svn\&.findcopiesharder +.fi + +.TP +\-A, \-\-authors\-file= +Syntax is compatible with the files used by git\-svnimport and git\-cvsimport: + +.nf +loginname = Joe User +.fi + +.nf +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\&. +.fi + +.nf +repo\-config key: svn\&.authors\-file +.fi + +.SH "ADVANCED OPTIONS" + +.TP +\-b, \-\-branch +Used with \fIfetch\fR or \fIcommit\fR\&. + +.nf +This can be used to join arbitrary git branches to remotes/git\-svn +on new commits where the tree object is equivalent\&. +.fi + +.nf +When used with different GIT_SVN_ID values, tags and branches in +SVN can be tracked this way, as can some merges where the heads +end up having completely equivalent content\&. This can even be +used to track branches across multiple SVN _repositories_\&. +.fi + +.nf +This option may be specified multiple times, once for each +branch\&. +.fi + +.nf +repo\-config key: svn\&.branch +.fi + +.TP +\-i, \-\-id +This sets GIT_SVN_ID (instead of using the environment)\&. See the section on "Tracking Multiple Repositories or Branches" for more information on using GIT_SVN_ID\&. + +.SH "COMPATIBILITY OPTIONS" + +.TP +\-\-upgrade +Only used with the \fIrebuild\fR command\&. + +.nf +Run this if you used an old version of git\-svn that used +"git\-svn\-HEAD" instead of "remotes/git\-svn" as the branch +for tracking the remote\&. +.fi + +.TP +\-\-no\-ignore\-externals +Only used with the \fIfetch\fR and \fIrebuild\fR command\&. + +.nf +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\&. +.fi + +.nf +Versions of svn that do not support \-\-ignore\-externals are +automatically detected and this flag will be automatically +enabled for them\&. +.fi + +.nf +Otherwise, do not enable this flag unless you know what you're +doing\&. +.fi + +.nf +repo\-config key: svn\&.noignoreexternals +.fi + +.SS "Basic Examples" + + +Tracking and contributing to an Subversion managed\-project: + +.nf +# Initialize a tree (like git init\-db): + git\-svn init http://svn\&.foo\&.org/project/trunk +# Fetch remote revisions: + git\-svn fetch +# Create your own branch to hack on: + git checkout \-b my\-branch remotes/git\-svn +# Commit only the git commits you want to SVN: + git\-svn commit [ \&.\&.\&.] +# Commit all the git commits from my\-branch that don't exist in SVN: + git\-svn commit remotes/git\-svn\&.\&.my\-branch +# Something is committed to SVN, pull the latest into your branch: + git\-svn fetch && git pull \&. remotes/git\-svn +# Append svn:ignore settings to the default git exclude file: + git\-svn show\-ignore >> \&.git/info/exclude +.fi + +.SH "DESIGN PHILOSOPHY" + + +Merge tracking in Subversion is lacking and doing branched development with Subversion is cumbersome as a result\&. git\-svn completely forgoes any automated merge/branch tracking on the Subversion side and leaves it entirely up to the user on the git side\&. It's simply not worth it to do a useful translation when the original signal is weak\&. + +.SH "TRACKING MULTIPLE REPOSITORIES OR BRANCHES" + + +This is for advanced users, most users should ignore this section\&. + + +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\&. + +.SH "ADDITIONAL FETCH ARGUMENTS" + + +This is for advanced users, most users should ignore this section\&. + + +Unfetched SVN revisions may be imported as children of existing commits by specifying additional arguments to \fIfetch\fR\&. Additional parents may optionally be specified in the form of sha1 hex sums at the command\-line\&. Unfetched SVN revisions may also be tied to particular git commits with the following syntax: + +.nf +svn_revision_number=git_commit_sha1 +.fi + +.TP +This allows you to tie unfetched SVN revision 375 to your current HEAD + git\-svn fetch 375=$(git\-rev\-parse HEAD) + +.SS "Advanced Example: Tracking a Reorganized Repository" + + +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\&. + + +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\&. + +.nf + # This log message shows when the repository was reorganized: + r166 | ydirson | 2006\-03\-02 01:36:55 +0100 (Thu, 02 Mar 2006) | 1 line + Changed paths: + D /trunk + A /ufoai/trunk (from /trunk:165) + + # First we start tracking the old revisions: + GIT_SVN_ID=git\-oldsvn git\-svn init \\ + https://svn\&.sourceforge\&.net/svnroot/ufoai/trunk + GIT_SVN_ID=git\-oldsvn git\-svn fetch \-r1:165 + + # And now, we continue tracking the new revisions: + GIT_SVN_ID=git\-newsvn git\-svn init \\ + https://svn\&.sourceforge\&.net/svnroot/ufoai/ufoai/trunk + GIT_SVN_ID=git\-newsvn git\-svn fetch \\ + 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\&. + + +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\&. + + +svn:keywords can't be ignored in Subversion (at least I don't know of a way to ignore them)\&. + + +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\&. + +.SH "AUTHOR" + + +Written by Eric Wong \&. + +.SH "DOCUMENTATION" + + +Written by Eric Wong \&. + -- 2.26.2