From: Junio C Hamano Date: Fri, 10 Feb 2006 05:52:17 +0000 (+0000) Subject: Autogenerated man pages for v1.1.6-g91c7 X-Git-Url: https://git.verplant.org/?a=commitdiff_plain;h=a3960eec6c3363d3af4f5ea1a479a77d095d01bb;p=git.git Autogenerated man pages for v1.1.6-g91c7 --- diff --git a/man1/git-diff-files.1 b/man1/git-diff-files.1 index 8a134535..5bc398a0 100755 --- a/man1/git-diff-files.1 +++ b/man1/git-diff-files.1 @@ -23,7 +23,7 @@ git-diff-files \- Compares files in the working tree and the index .SH "SYNOPSIS" -git\-diff\-files [\-q] [\-0|\-1|\-2|\-3|\-c|\-\-cc] [] [...] +\fIgit\-diff\-files\fR [\-q] [\-0|\-1|\-2|\-3|\-c|\-\-cc] [] [...] .SH "DESCRIPTION" @@ -73,6 +73,10 @@ Detect renames\&. Detect copies as well as renames\&. .TP +\-\-diff\-filter=[ACDMRTUXB*] +Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&. + +.TP \-\-find\-copies\-harder For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&. @@ -107,7 +111,7 @@ The default is to diff against our branch (\-2) and the cleanly resolved paths\& .TP \-c,\-\-cc -This compares stage 2 (our branch), stage 3 (their branch) and the working tree file and outputs a combined diff, similar to the way diff\-tree shows a merge commit with these flags\&. +This compares stage 2 (our branch), stage 3 (their branch) and the working tree file and outputs a combined diff, similar to the way \fIdiff\-tree\fR shows a merge commit with these flags\&. .TP \-q @@ -182,19 +186,19 @@ a space\&. status, followed by optional "score" number\&. .TP 11. -a tab or a NUL when \-z option is used\&. +a tab or a NUL when \fI\-z\fR option is used\&. .TP 12. path for "src" .TP 13. -a tab or a NUL when \-z option is used; only exists for C or R\&. +a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&. .TP 14. path for "dst"; only exists for C or R\&. .TP 15. -an LF or a NUL when \-z option is used, to terminate the record\&. +an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&. .LP @@ -211,14 +215,14 @@ When \-z option is not used, TAB, LF, and backslash characters in pathnames are .SH "GENERATING PATCHES WITH -P" -When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \-p option, they do not produce the output described above; instead they produce a patch file\&. +When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file\&. The patch generation can be customized at two levels\&. .TP 3 1. -When the environment variable GIT_EXTERNAL_DIFF is not set, these commands internally invoke "diff" like this: +When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this: .nf @@ -226,16 +230,16 @@ diff \-L a/ \-L b/ \-pu .fi For added files, /dev/null is used for \&. For removed files, /dev/null is used for -The "diff" formatting options can be customized via the environment variable GIT_DIFF_OPTS\&. For example, if you prefer context diff: +The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff: .nf GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD .fi .TP 2. -When the environment variable GIT_EXTERNAL_DIFF is set, the program named by it is called, instead of the diff invocation described above\&. +When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&. -For a path that is added, removed, or modified, GIT_EXTERNAL_DIFF is called with 7 parameters: +For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters: .nf @@ -244,16 +248,22 @@ path old\-file old\-hex old\-mode new\-file new\-hex new\-mode where: \-file + are files GIT_EXTERNAL_DIFF can use to read the contents of , + \-hex + are the 40\-hexdigit SHA1 hashes, + \-mode + are the octal representation of the file modes\&. -The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. GIT_EXTERNAL_DIFF should not worry about unlinking the temporary file \-\-\- it is removed when GIT_EXTERNAL_DIFF exits\&. + +The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. \fIGIT_EXTERNAL_DIFF\fR should not worry about unlinking the temporary file \-\-\- it is removed when \fIGIT_EXTERNAL_DIFF\fR exits\&. .LP -For a path that is unmerged, GIT_EXTERNAL_DIFF is called with 1 parameter, \&. +For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, \&. .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT" @@ -296,7 +306,7 @@ TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and .SH "COMBINED DIFF FORMAT" -git\-diff\-tree and git\-diff\-files can take \-c or \-\-cc option to produce combined diff, which looks like this: +git\-diff\-tree and git\-diff\-files can take \fI\-c\fR or \fI\-\-cc\fR option to produce \fIcombined diff\fR, which looks like this: .IP diff \-\-combined describe\&.c @@ -311,7 +321,7 @@ diff \-\-combined describe\&.c + unsigned char sha1[20]; + struct commit *cmit; -Unlike the traditional unified diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&. +Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&. A \- character in the column N means that the line appears in fileN but it does not appear in the last file\&. A + character in the column N means that the line appears in the last file, and fileN does not have that line\&. diff --git a/man1/git-diff-index.1 b/man1/git-diff-index.1 index 6a4f1efc..1551b13a 100755 --- a/man1/git-diff-index.1 +++ b/man1/git-diff-index.1 @@ -23,7 +23,7 @@ git-diff-index \- Compares content and mode of blobs between the index and repos .SH "SYNOPSIS" -git\-diff\-index [\-m] [\-\-cached] [] [...] +\fIgit\-diff\-index\fR [\-m] [\-\-cached] [] [...] .SH "DESCRIPTION" @@ -73,6 +73,10 @@ Detect renames\&. Detect copies as well as renames\&. .TP +\-\-diff\-filter=[ACDMRTUXB*] +Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&. + +.TP \-\-find\-copies\-harder For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&. @@ -180,19 +184,19 @@ a space\&. status, followed by optional "score" number\&. .TP 11. -a tab or a NUL when \-z option is used\&. +a tab or a NUL when \fI\-z\fR option is used\&. .TP 12. path for "src" .TP 13. -a tab or a NUL when \-z option is used; only exists for C or R\&. +a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&. .TP 14. path for "dst"; only exists for C or R\&. .TP 15. -an LF or a NUL when \-z option is used, to terminate the record\&. +an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&. .LP @@ -209,14 +213,14 @@ When \-z option is not used, TAB, LF, and backslash characters in pathnames are .SH "GENERATING PATCHES WITH -P" -When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \-p option, they do not produce the output described above; instead they produce a patch file\&. +When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file\&. The patch generation can be customized at two levels\&. .TP 3 1. -When the environment variable GIT_EXTERNAL_DIFF is not set, these commands internally invoke "diff" like this: +When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this: .nf @@ -224,16 +228,16 @@ diff \-L a/ \-L b/ \-pu .fi For added files, /dev/null is used for \&. For removed files, /dev/null is used for -The "diff" formatting options can be customized via the environment variable GIT_DIFF_OPTS\&. For example, if you prefer context diff: +The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff: .nf GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD .fi .TP 2. -When the environment variable GIT_EXTERNAL_DIFF is set, the program named by it is called, instead of the diff invocation described above\&. +When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&. -For a path that is added, removed, or modified, GIT_EXTERNAL_DIFF is called with 7 parameters: +For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters: .nf @@ -242,16 +246,22 @@ path old\-file old\-hex old\-mode new\-file new\-hex new\-mode where: \-file + are files GIT_EXTERNAL_DIFF can use to read the contents of , + \-hex + are the 40\-hexdigit SHA1 hashes, + \-mode + are the octal representation of the file modes\&. -The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. GIT_EXTERNAL_DIFF should not worry about unlinking the temporary file \-\-\- it is removed when GIT_EXTERNAL_DIFF exits\&. + +The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. \fIGIT_EXTERNAL_DIFF\fR should not worry about unlinking the temporary file \-\-\- it is removed when \fIGIT_EXTERNAL_DIFF\fR exits\&. .LP -For a path that is unmerged, GIT_EXTERNAL_DIFF is called with 1 parameter, \&. +For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, \&. .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT" @@ -294,7 +304,7 @@ TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and .SH "COMBINED DIFF FORMAT" -git\-diff\-tree and git\-diff\-files can take \-c or \-\-cc option to produce combined diff, which looks like this: +git\-diff\-tree and git\-diff\-files can take \fI\-c\fR or \fI\-\-cc\fR option to produce \fIcombined diff\fR, which looks like this: .IP diff \-\-combined describe\&.c @@ -309,7 +319,7 @@ diff \-\-combined describe\&.c + unsigned char sha1[20]; + struct commit *cmit; -Unlike the traditional unified diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&. +Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&. A \- character in the column N means that the line appears in fileN but it does not appear in the last file\&. A + character in the column N means that the line appears in the last file, and fileN does not have that line\&. @@ -323,12 +333,12 @@ When shown by git diff\-tree \-c, it compares the parents of a merge commit with .SH "OPERATING MODES" -You can choose whether you want to trust the index file entirely (using the \-\-cached flag) or ask the diff logic to show any files that don't match the stat state as being "tentatively changed"\&. Both of these operations are very useful indeed\&. +You can choose whether you want to trust the index file entirely (using the \fI\-\-cached\fR flag) or ask the diff logic to show any files that don't match the stat state as being "tentatively changed"\&. Both of these operations are very useful indeed\&. .SH "CACHED MODE" -If \-\-cached is specified, it allows you to ask: +If \fI\-\-cached\fR is specified, it allows you to ask: .nf show me the differences between HEAD and the current index @@ -336,7 +346,7 @@ contents (the ones I'd write with a "git\-write\-tree") .fi -For example, let's say that you have worked on your working directory, updated some files in the index and are ready to commit\&. You want to see exactly what you are going to commit is without having to write a new tree object and compare it that way, and to do that, you just do +For example, let's say that you have worked on your working directory, updated some files in the index and are ready to commit\&. You want to see exactly \fIwhat\fR you are going to commit is without having to write a new tree object and compare it that way, and to do that, you just do .nf git\-diff\-index \-\-cached HEAD @@ -355,7 +365,7 @@ torvalds@ppc970:~/git> git\-diff\-index \-\-cached HEAD You can trivially see that the above is a rename\&. -In fact, "git\-diff\-index \-\-cached" should always be entirely equivalent to actually doing a "git\-write\-tree" and comparing that\&. Except this one is much nicer for the case where you just want to check where you are\&. +In fact, "git\-diff\-index \-\-cached" \fIshould\fR always be entirely equivalent to actually doing a "git\-write\-tree" and comparing that\&. Except this one is much nicer for the case where you just want to check where you are\&. So doing a "git\-diff\-index \-\-cached" is basically very useful when you are asking yourself "what have I already marked for being committed, and what's the difference to a previous tree"\&. @@ -371,7 +381,7 @@ tree \- index contents _and_ files that aren't up\-to\-date .fi -which is obviously a very useful question too, since that tells you what you could commit\&. Again, the output matches the "git\-diff\-tree \-r" output to a tee, but with a twist\&. +which is obviously a very useful question too, since that tells you what you \fIcould\fR commit\&. Again, the output matches the "git\-diff\-tree \-r" output to a tee, but with a twist\&. The twist is that if some file doesn't match the index, we don't have a backing store thing for it, and we use the magic "all\-zero" sha1 to show that\&. So let's say that you have edited kernel/sched\&.c, but have not actually done a "git\-update\-index" on it yet \- there is no "object" associated with the new state, and you get: diff --git a/man1/git-diff-stages.1 b/man1/git-diff-stages.1 index ac54d048..5c250154 100755 --- a/man1/git-diff-stages.1 +++ b/man1/git-diff-stages.1 @@ -23,7 +23,7 @@ git-diff-stages \- Compares content and mode of blobs between stages in an unmer .SH "SYNOPSIS" -git\-diff\-stages [] [...] +\fIgit\-diff\-stages\fR [] [...] .SH "DESCRIPTION" @@ -73,6 +73,10 @@ Detect renames\&. Detect copies as well as renames\&. .TP +\-\-diff\-filter=[ACDMRTUXB*] +Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&. + +.TP \-\-find\-copies\-harder For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&. @@ -172,19 +176,19 @@ a space\&. status, followed by optional "score" number\&. .TP 11. -a tab or a NUL when \-z option is used\&. +a tab or a NUL when \fI\-z\fR option is used\&. .TP 12. path for "src" .TP 13. -a tab or a NUL when \-z option is used; only exists for C or R\&. +a tab or a NUL when \fI\-z\fR option is used; only exists for C or R\&. .TP 14. path for "dst"; only exists for C or R\&. .TP 15. -an LF or a NUL when \-z option is used, to terminate the record\&. +an LF or a NUL when \fI\-z\fR option is used, to terminate the record\&. .LP @@ -201,14 +205,14 @@ When \-z option is not used, TAB, LF, and backslash characters in pathnames are .SH "GENERATING PATCHES WITH -P" -When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \-p option, they do not produce the output described above; instead they produce a patch file\&. +When "git\-diff\-index", "git\-diff\-tree", or "git\-diff\-files" are run with a \fI\-p\fR option, they do not produce the output described above; instead they produce a patch file\&. The patch generation can be customized at two levels\&. .TP 3 1. -When the environment variable GIT_EXTERNAL_DIFF is not set, these commands internally invoke "diff" like this: +When the environment variable \fIGIT_EXTERNAL_DIFF\fR is not set, these commands internally invoke "diff" like this: .nf @@ -216,16 +220,16 @@ diff \-L a/ \-L b/ \-pu .fi For added files, /dev/null is used for \&. For removed files, /dev/null is used for -The "diff" formatting options can be customized via the environment variable GIT_DIFF_OPTS\&. For example, if you prefer context diff: +The "diff" formatting options can be customized via the environment variable \fIGIT_DIFF_OPTS\fR\&. For example, if you prefer context diff: .nf GIT_DIFF_OPTS=\-c git\-diff\-index \-p HEAD .fi .TP 2. -When the environment variable GIT_EXTERNAL_DIFF is set, the program named by it is called, instead of the diff invocation described above\&. +When the environment variable \fIGIT_EXTERNAL_DIFF\fR is set, the program named by it is called, instead of the diff invocation described above\&. -For a path that is added, removed, or modified, GIT_EXTERNAL_DIFF is called with 7 parameters: +For a path that is added, removed, or modified, \fIGIT_EXTERNAL_DIFF\fR is called with 7 parameters: .nf @@ -234,16 +238,22 @@ path old\-file old\-hex old\-mode new\-file new\-hex new\-mode where: \-file + are files GIT_EXTERNAL_DIFF can use to read the contents of , + \-hex + are the 40\-hexdigit SHA1 hashes, + \-mode + are the octal representation of the file modes\&. -The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. GIT_EXTERNAL_DIFF should not worry about unlinking the temporary file \-\-\- it is removed when GIT_EXTERNAL_DIFF exits\&. + +The file parameters can point at the user's working file (e\&.g\&. new\-file in "git\-diff\-files"), /dev/null (e\&.g\&. old\-file when a new file is added), or a temporary file (e\&.g\&. old\-file in the index)\&. \fIGIT_EXTERNAL_DIFF\fR should not worry about unlinking the temporary file \-\-\- it is removed when \fIGIT_EXTERNAL_DIFF\fR exits\&. .LP -For a path that is unmerged, GIT_EXTERNAL_DIFF is called with 1 parameter, \&. +For a path that is unmerged, \fIGIT_EXTERNAL_DIFF\fR is called with 1 parameter, \&. .SH "GIT SPECIFIC EXTENSION TO DIFF FORMAT" @@ -286,7 +296,7 @@ TAB, LF, and backslash characters in pathnames are represented as \\t, \\n, and .SH "COMBINED DIFF FORMAT" -git\-diff\-tree and git\-diff\-files can take \-c or \-\-cc option to produce combined diff, which looks like this: +git\-diff\-tree and git\-diff\-files can take \fI\-c\fR or \fI\-\-cc\fR option to produce \fIcombined diff\fR, which looks like this: .IP diff \-\-combined describe\&.c @@ -301,7 +311,7 @@ diff \-\-combined describe\&.c + unsigned char sha1[20]; + struct commit *cmit; -Unlike the traditional unified diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&. +Unlike the traditional \fIunified\fR diff format, which shows two files A and B with a single column that has \- (minus -- appears in A but removed in B), + (plus -- missing in A but added to B), or (space -- unchanged) prefix, this format compares two or more files file1, file2,... with one file X, and shows how X differs from each of fileN\&. One column for each of fileN is prepended to the output line to note how X's line is different from it\&. A \- character in the column N means that the line appears in fileN but it does not appear in the last file\&. A + character in the column N means that the line appears in the last file, and fileN does not have that line\&. diff --git a/man1/git-diff-tree.1 b/man1/git-diff-tree.1 index 4c8cbca6..b93a0599 100755 --- a/man1/git-diff-tree.1 +++ b/man1/git-diff-tree.1 @@ -82,6 +82,10 @@ Detect renames\&. Detect copies as well as renames\&. .TP +\-\-diff\-filter=[ACDMRTUXB*] +Select only files that are Added (A), Copied (C), Deleted (D), Modified (M), Renamed (R), have their type (mode) changed (T), are Unmerged (U), are Unknown (X), or have had their pairing Broken (B)\&. Any combination of the filter characters may be used\&. When * (All\-or\-none) is added to the combination, all paths are selected if there is any file that matches other criteria in the comparison; if there is no file that matches other criteria, nothing is selected\&. + +.TP \-\-find\-copies\-harder For performance reasons, by default, \-C option finds copies only if the original file of the copy was modified in the same changeset\&. This flag makes the command inspect unmodified files as candidates for the source of copy\&. This is a very expensive operation for large projects, so use it with caution\&.