From: Miklos Vajna <vmiklos@frugalware.org>
To: Junio C Hamano <gitster@pobox.com>
Cc: git@vger.kernel.org
Subject: [PATCH] Documentation: move options of git-diff-tree to a separate file.
Date: Sun, 27 Apr 2008 04:17:41 +0200 [thread overview]
Message-ID: <1209262661-14370-1-git-send-email-vmiklos@frugalware.org> (raw)
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:
> 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
next prev parent reply other threads:[~2008-04-27 2:18 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2008-04-26 21:01 [PATCH 1/2] Documentation: move options of git-diff-tree to a separate file Miklos Vajna
2008-04-26 21:01 ` [PATCH 2/2] Documentation: include diff-tree-options in git-show manpage Miklos Vajna
2008-04-27 0:24 ` [PATCH 1/2] Documentation: move options of git-diff-tree to a separate file Junio C Hamano
2008-04-27 2:17 ` Miklos Vajna [this message]
2008-04-27 7:29 ` [PATCH] " しらいしななこ
[not found] ` <200804270730.m3R7UTTp011092@mi1.bluebottle.com>
2008-04-27 11:45 ` [PATCH] git show documentation: no longer refer to git-diff-tree options Miklos Vajna
2008-04-27 17:33 ` Junio C Hamano
2008-05-11 22:37 ` Miklos Vajna
2008-05-12 23:10 ` Junio C Hamano
2008-05-13 9:11 ` Miklos Vajna
2008-05-13 9:16 ` Miklos Vajna
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1209262661-14370-1-git-send-email-vmiklos@frugalware.org \
--to=vmiklos@frugalware.org \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).