From: Junio C Hamano <gitster@pobox.com>
Date: Fri, 16 Mar 2012 04:54:30 +0000 (-0700)
Subject: Merge branch 'th/doc-diff-submodule-option'
X-Git-Tag: v1.7.10-rc2~12
X-Git-Url: https://git.lorimer.id.au/gitweb.git/diff_plain/c58499c317ccb04aba4e0c5b3bee78683027f095

Merge branch 'th/doc-diff-submodule-option'

* th/doc-diff-submodule-option:
Documentation/diff-options: reword description of --submodule option
---

c58499c317ccb04aba4e0c5b3bee78683027f095
diff --cc Documentation/diff-options.txt
index 7d4566f829,286d84da40..378f19f0e2
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@@ -165,61 -88,25 +165,62 @@@ any of those replacements occurred
  	of the `--diff-filter` option on what the status letters mean.
  
  --submodule[=<format>]::
- 	Chose the output format for submodule differences. <format> can be one of
- 	'short' and 'log'. 'short' just shows pairs of commit names, this format
- 	is used when this option is not given. 'log' is the default value for this
- 	option and lists the commits in that commit range like the 'summary'
- 	option of linkgit:git-submodule[1] does.
+ 	Specify how differences in submodules are shown.  When `--submodule`
+ 	or `--submodule=log` is given, the 'log' format is used.  This format lists
+ 	the commits in the range like linkgit:git-submodule[1] `summary` does.
+ 	Omitting the `--submodule` option or specifying `--submodule=short`,
+ 	uses the 'short' format. This format just shows the names of the commits
+ 	at the beginning and end of the range.
  
 ---color::
 +--color[=<when>]::
  	Show colored diff.
 +	The value must be `always` (the default for `<when>`), `never`, or `auto`.
 +	The default value is `never`.
 +ifdef::git-diff[]
 +	It can be changed by the `color.ui` and `color.diff`
 +	configuration settings.
 +endif::git-diff[]
  
  --no-color::
 -	Turn off colored diff, even when the configuration file
 -	gives the default to color output.
 +	Turn off colored diff.
 +ifdef::git-diff[]
 +	This can be used to override configuration settings.
 +endif::git-diff[]
 +	It is the same as `--color=never`.
  
 ---color-words[=<regex>]::
 -	Show colored word diff, i.e., color words which have changed.
 -	By default, words are separated by whitespace.
 +--word-diff[=<mode>]::
 +	Show a word diff, using the <mode> to delimit changed words.
 +	By default, words are delimited by whitespace; see
 +	`--word-diff-regex` below.  The <mode> defaults to 'plain', and
 +	must be one of:
  +
 -When a <regex> is specified, every non-overlapping match of the
 +--
 +color::
 +	Highlight changed words using only colors.  Implies `--color`.
 +plain::
 +	Show words as `[-removed-]` and `{+added+}`.  Makes no
 +	attempts to escape the delimiters if they appear in the input,
 +	so the output may be ambiguous.
 +porcelain::
 +	Use a special line-based format intended for script
 +	consumption.  Added/removed/unchanged runs are printed in the
 +	usual unified diff format, starting with a `+`/`-`/` `
 +	character at the beginning of the line and extending to the
 +	end of the line.  Newlines in the input are represented by a
 +	tilde `~` on a line of its own.
 +none::
 +	Disable word diff again.
 +--
 ++
 +Note that despite the name of the first mode, color is used to
 +highlight the changed parts in all modes if enabled.
 +
 +--word-diff-regex=<regex>::
 +	Use <regex> to decide what a word is, instead of considering
 +	runs of non-whitespace to be a word.  Also implies
 +	`--word-diff` unless it was already enabled.
 ++
 +Every non-overlapping match of the
  <regex> is considered a word.  Anything between these matches is
  considered whitespace and ignored(!) for the purposes of finding
  differences.  You may want to append `|[^[:space:]]` to your regular