From 47848ae0b2e2aa48f285bef6aa9fde0efa4295cd Mon Sep 17 00:00:00 2001 From: Junio C Hamano Date: Thu, 14 Dec 2006 11:20:06 +0000 Subject: [PATCH] Autogenerated HTML docs for v1.4.4.2-g02c9 --- git-diff.html | 400 ++++++++++++++++++++++++++++++++++++++++++++++---- git-diff.txt | 56 ++++--- 2 files changed, 406 insertions(+), 50 deletions(-) diff --git a/git-diff.html b/git-diff.html index eb8abec52..8538378eb 100644 --- a/git-diff.html +++ b/git-diff.html @@ -277,54 +277,394 @@ git-diff(1) Manual Page

DESCRIPTION

Show changes between two trees, a tree and the working tree, a -tree and the index file, or the index file and the working tree. -The combination of what is compared with what is determined by -the number of trees given to the command.

- + +
+git-diff [--options] <commit> <commit> — [<path>…] +
+
+

+ This form is to view the changes between two <commit>, + for example, tips of two branches. +

+
+ +

Just in case if you are doing something exotic, it should be +noted that all of the <commit> in the above description can be +any <tree-ish>.

OPTIONS

---diff-options +-p +
+
+

+ Generate patch (see section on generating patches) +

+
+
+-u +
+
+

+ Synonym for "-p". +

+
+
+--raw +
+
+

+ Generate the raw format. +

+
+
+--patch-with-raw +
+
+

+ Synonym for "-p --raw". +

+
+
+--stat[=width[,name-width]] +
+
+

+ Generate a diffstat. You can override the default + output width for 80-column terminal by "--stat=width". + The width of the filename part can be controlled by + giving another width to it separated by a comma. +

+
+
+--numstat +
+
+

+ Similar to --stat, but shows number of added and + deleted lines in decimal notation and pathname without + abbreviation, to make it more machine friendly. +

+
+
+--summary +
+
+

+ Output a condensed summary of extended header information + such as creations, renames and mode changes. +

+
+
+--patch-with-stat +
+
+

+ Synonym for "-p --stat". +

+
+
+-z +
+
+

+ \0 line termination on output +

+
+
+--name-only +
+
+

+ Show only names of changed files. +

+
+
+--name-status +
+
+

+ Show only names and status of changed files. +

+
+
+--color +
+
+

+ Show colored diff. +

+
+
+--no-color +
+
+

+ Turn off colored diff, even when the configuration file + gives the default to color output. +

+
+
+--color-words +
+
+

+ Show colored word diff, i.e. color words which have changed. +

+
+
+--no-renames +
+
+

+ Turn off rename detection, even when the configuration + file gives the default to do so. +

+
+
+--full-index

- --diff-options are passed to the git-diff-files, - git-diff-index, and git-diff-tree commands. See the - documentation for these commands for description. + 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.

+--binary +
+
+

+ In addition to --full-index, output "binary diff" that + can be applied with "git apply". +

+
+
+--abbrev[=<n>] +
+
+

+ 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=<n>. +

+
+
+-B +
+
+

+ Break complete rewrite changes into pairs of delete and create. +

+
+
+-M +
+
+

+ Detect renames. +

+
+
+-C +
+
+

+ Detect copies as well as renames. +

+
+
+--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. +

+
+
+--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. +

+
+
+-l<num> +
+
+

+ -M and -C options require O(n^2) processing time where n + is the number of potential rename/copy targets. This + option prevents rename/copy detection from running if + the number of rename/copy targets exceeds the specified + number. +

+
+
+-S<string> +
+
+

+ Look for differences that contain the change in <string>. +

+
+
+--pickaxe-all +
+
+

+ When -S finds a change, show all the changes in that + changeset, not just the files that contain the change + in <string>. +

+
+
+--pickaxe-regex +
+
+

+ Make the <string> not a plain string but an extended POSIX + regex to match. +

+
+
+-O<orderfile> +
+
+

+ Output the patch in the order specified in the + <orderfile>, which has one shell glob pattern per line. +

+
+
+-R +
+
+

+ Swap two inputs; that is, show differences from index or + on-disk file to tree contents. +

+
+
+--text +
+
+

+ Treat all files as text. +

+
+
+-a +
+
+

+ Shorthand for "--text". +

+
+
+--ignore-space-change +
+
+

+ Ignore changes in amount of white space. This ignores white + space at line end, and consider all other sequences of one or + more white space characters to be equivalent. +

+
+
+-b +
+
+

+ Shorthand for "--ignore-space-change". +

+
+
+--ignore-all-space +
+
+

+ Ignore white space when comparing lines. This ignores + difference even if one line has white space where the other + line has none. +

+
+
+-w +
+
+

+ Shorthand for "--ignore-all-space". +

+
+
+

For more detailed explanation on these common options, see also +diffcore documentation.

+
+
<path>…

- The <path> arguments are also passed to git-diff-* - commands. + The <paths> parameters, when given, are used to limit + the diff to the named paths (you can give directory + names and get diff for all files under them).

@@ -339,13 +679,13 @@ Various ways to check your working tree 
$ git diff            (1)
-$ git diff --index    (2)
+$ git diff --cached   (2)
 $ git diff HEAD       (3)

  1. -changes in the working tree since your last git-update-index. +changes in the working tree not yet staged for the next commit.

  2. @@ -465,7 +805,7 @@ output diff in reverse.
diff --git a/git-diff.txt b/git-diff.txt index 3144864d8..127d68c96 100644 --- a/git-diff.txt +++ b/git-diff.txt @@ -14,32 +14,48 @@ DESCRIPTION ----------- Show changes between two trees, a tree and the working tree, a tree and the index file, or the index file and the working tree. -The combination of what is compared with what is determined by -the number of trees given to the command. -* When no is given, the working tree and the index - file are compared, using `git-diff-files`. +'git-diff' [--options] [--] [...]:: -* When one is given, the working tree and the named - tree are compared, using `git-diff-index`. The option - `--index` can be given to compare the index file and - the named tree. - `--cached` is a deprecated alias for `--index`. It's use is - discouraged. + This form is to view the changes you made relative to + the index (staging area for the next commit). In other + words, the differences are what you _could_ tell git to + further add to the index but you still haven't. You can + stage these changes by using gitlink:git-add[1]. + +'git-diff' [--options] --cached [] [--] [...]:: + + This form is to view the changes you staged for the next + commit relative to the named . Typically you + would want comparison with the latest commit, so if you + do not give , it defaults to HEAD. + +'git-diff' [--options] -- [...]:: + + This form is to view the changes you have in your + working tree relative to the named . You can + use HEAD to compare it with the latest commit, or a + branch name to compare with the tip of a different + branch. + +'git-diff' [--options] -- [...]:: + + This form is to view the changes between two , + for example, tips of two branches. + +Just in case if you are doing something exotic, it should be +noted that all of the in the above description can be +any . -* When two s are given, these two trees are compared - using `git-diff-tree`. OPTIONS ------- ---diff-options:: - '--diff-options' are passed to the `git-diff-files`, - `git-diff-index`, and `git-diff-tree` commands. See the - documentation for these commands for description. +include::diff-options.txt[] ...:: - The arguments are also passed to `git-diff-\*` - commands. + The parameters, when given, are used to limit + the diff to the named paths (you can give directory + names and get diff for all files under them). EXAMPLES @@ -49,11 +65,11 @@ Various ways to check your working tree:: + ------------ $ git diff <1> -$ git diff --index <2> +$ git diff --cached <2> $ git diff HEAD <3> ------------ + -<1> changes in the working tree since your last git-update-index. +<1> changes in the working tree not yet staged for the next commit. <2> changes between the index and your last commit; what you would be committing if you run "git commit" without "-a" option. <3> changes in the working tree since your last commit; what you -- 2.26.2