[PATCH] Documentation: move options of git-diff-tree to a separate file.
- From
Miklos Vajna <vmiklos@frugalware.org>
- Date
- Apr 27, 2008, 02:17 UTC
- Message-ID
- <1209262661-14370-1-git-send-email-vmiklos@frugalware.org>
- In-Reply-To
- <7vod7wkuue.fsf@gitster.siamese.dyndns.org>
These options are used by high-level commands, like git-show; moving the options to a separate file makes it possible to include the options in the high-level manges as well.
Signed-off-by: Miklos Vajna <vmiklos@frugalware.org> ---
On Sat, Apr 26, 2008 at 05:24:57PM -0700, Junio C Hamano <gitster@pobox.com> wrote:
Show 10 quoted lines
> Are you sure "git show" takes --stdin? > > Also for "show", listing --cc as one of the options does not make much > sense, as that is an unoverridable default. > > And no, making it overridable so that it can take -m to show > independent > diff against each parent of a merge commit do not make much sense in > the > context of "git show".
Right, --stdin and --cc is not something I should move to diff-tree-options.txt. Updated patch below.
Documentation/diff-tree-options.txt | 43 ++++++++++++++++++++++++++++++ Documentation/git-diff-tree.txt | 49 +++-------------------------------- 2 files changed, 47 insertions(+), 45 deletions(-) create mode 100644 Documentation/diff-tree-options.txt
diff --git a/Documentation/diff-tree-options.txt b/Documentation/diff-tree-options.txt new file mode 100644 index 0000000..3049ede --- /dev/null +++ b/Documentation/diff-tree-options.txt @@ -0,0 +1,43 @@ +-r:: + recurse into sub-trees + +-t:: + show tree entry itself as well as subtrees. Implies -r. + +--root:: + When '--root' is specified the initial commit will be showed as a big + creation event. This is equivalent to a diff against the NULL tree. + +-m:: + By default, "--stdin" does not show + differences for merge commits. With this flag, it shows + differences to that commit from all of its parents. See + also '-c'. + +-s:: + By default, "--stdin" shows differences, + either in machine-readable form (without '-p') or in patch + form (with '-p'). This output can be suppressed. It is + only useful with '-v' flag. + +-v:: + This flag causes "--stdin" to also show + the commit message before the differences. + +--no-commit-id:: + The output contains a line with the commit ID when + applicable. This flag suppressed the commit ID output. + +-c:: + This flag changes the way a merge commit is displayed + (which means it is useful only when the command is given + one <tree-ish>, or '--stdin'). It shows the differences + from each of the parents to the merge result simultaneously + instead of showing pairwise diff between a parent and the + result one at a time (which is what the '-m' option does). + Furthermore, it lists only files which were modified + from all parents. + +--always:: + Show the commit itself and the commit log message even + if the diff itself is empty. diff --git a/Documentation/git-diff-tree.txt b/Documentation/git-diff-tree.txt index 58d02c6..55345df 100644 --- a/Documentation/git-diff-tree.txt +++ b/Documentation/git-diff-tree.txt @@ -36,16 +36,6 @@ include::diff-options.txt[] Note that this parameter does not provide any wildcard or regexp features. --r:: - recurse into sub-trees - --t:: - show tree entry itself as well as subtrees. Implies -r. - ---root:: - When '--root' is specified the initial commit will be showed as a big - creation event. This is equivalent to a diff against the NULL tree. - --stdin:: When '--stdin' is specified, the command does not take <tree-ish> arguments from the command line. Instead, it @@ -57,38 +47,6 @@ the commit with its parents. The following flags further affects its behavior. This does not apply to the case where two <tree-ish> separated with a single space are given. --m:: - By default, "git-diff-tree --stdin" does not show - differences for merge commits. With this flag, it shows - differences to that commit from all of its parents. See - also '-c'. - --s:: - By default, "git-diff-tree --stdin" shows differences, - either in machine-readable form (without '-p') or in patch - form (with '-p'). This output can be suppressed. It is - only useful with '-v' flag. - --v:: - This flag causes "git-diff-tree --stdin" to also show - the commit message before the differences. - -include::pretty-options.txt[] - ---no-commit-id:: - git-diff-tree outputs a line with the commit ID when - applicable. This flag suppressed the commit ID output. - --c:: - This flag changes the way a merge commit is displayed - (which means it is useful only when the command is given - one <tree-ish>, or '--stdin'). It shows the differences - from each of the parents to the merge result simultaneously - instead of showing pairwise diff between a parent and the - result one at a time (which is what the '-m' option does). - Furthermore, it lists only files which were modified - from all parents. - --cc:: This flag changes the way a merge commit patch is displayed, in a similar way to the '-c' option. It implies the '-c' @@ -99,9 +57,10 @@ include::pretty-options.txt[] hunks disappear, the commit itself and the commit log message is not shown, just like in any other "empty diff" case. ---always:: - Show the commit itself and the commit log message even - if the diff itself is empty. +include::diff-tree-options.txt[] + + +include::pretty-options.txt[] include::pretty-formats.txt[]
-- 1.5.5.1