diff mbox series

[v2,6/7] doc/git-log: move "-t" into diff-options list

Message ID 20200729201210.GF2989342@coredump.intra.peff.net (mailing list archive)
State New, archived
Headers show
Series making log --first-parent imply -m | expand

Commit Message

Jeff King July 29, 2020, 8:12 p.m. UTC
The "-t" option is infrequently used; it doesn't deserve a spot near the
top of the options list. Let's push it down into the diff-options
include, near the definition of --raw.

We'll protect it with a git-log ifdef, since it doesn't make any sense
for non-tree diff commands. Note that this means it also shows up in
git-show, but that's a good thing; it applies equally well there.

Signed-off-by: Jeff King <peff@peff.net>
---
I'm open to suggestions of a better spot to put it. The diff options
list is a rather unwieldy mess.

 Documentation/diff-options.txt | 5 +++++
 Documentation/git-log.txt      | 3 ---
 2 files changed, 5 insertions(+), 3 deletions(-)

Comments

Junio C Hamano July 29, 2020, 9:10 p.m. UTC | #1
Jeff King <peff@peff.net> writes:

> The "-t" option is infrequently used; it doesn't deserve a spot near the
> top of the options list. Let's push it down into the diff-options
> include, near the definition of --raw.

True.  It does not have any effect unless --raw is in use (i.e.  it
does have an effect to "git show --patch-with-raw" or anything that
(also) shows "--raw" output), and it makes sense to have "-t" near
"--raw".
Jeff King July 29, 2020, 9:55 p.m. UTC | #2
On Wed, Jul 29, 2020 at 02:10:31PM -0700, Junio C Hamano wrote:

> Jeff King <peff@peff.net> writes:
> 
> > The "-t" option is infrequently used; it doesn't deserve a spot near the
> > top of the options list. Let's push it down into the diff-options
> > include, near the definition of --raw.
> 
> True.  It does not have any effect unless --raw is in use (i.e.  it
> does have an effect to "git show --patch-with-raw" or anything that
> (also) shows "--raw" output), and it makes sense to have "-t" near
> "--raw".

It affects --name-status, etc, too. But yeah, I would think the primary
use is with --raw.

-Peff
diff mbox series

Patch

diff --git a/Documentation/diff-options.txt b/Documentation/diff-options.txt
index 7987d72b02..b7af973d9c 100644
--- a/Documentation/diff-options.txt
+++ b/Documentation/diff-options.txt
@@ -73,6 +73,11 @@  ifndef::git-format-patch[]
 	Synonym for `-p --raw`.
 endif::git-format-patch[]
 
+ifdef::git-log[]
+-t::
+	Show the tree objects in the diff output.
+endif::git-log[]
+
 --indent-heuristic::
 	Enable the heuristic that shifts diff hunk boundaries to make patches
 	easier to read. This is the default.
diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
index 2cbe636b2b..0a4c99e5f8 100644
--- a/Documentation/git-log.txt
+++ b/Documentation/git-log.txt
@@ -146,9 +146,6 @@  below can be used to show the changes made by each commit.
 	in that case, the output represents the changes the merge
 	brought _into_ the then-current branch.
 
--t::
-	Show the tree objects in the diff output.
-
 :git-log: 1
 include::diff-options.txt[]