git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Ramkumar Ramachandra <artagnon@gmail.com>
To: Git List <git@vger.kernel.org>
Cc: Junio C Hamano <gitster@pobox.com>
Subject: [PATCH 5/5] git-diff.txt: fix ordering of the [--no-index] form
Date: Wed, 24 Apr 2013 22:03:36 +0530	[thread overview]
Message-ID: <1366821216-20868-6-git-send-email-artagnon@gmail.com> (raw)
In-Reply-To: <1366821216-20868-1-git-send-email-artagnon@gmail.com>

The SYNOPSIS lists the [--no-index] form as the last item, but the
DESCRIPTION lists it as a natural extension of the first form.  Fix
this with a reordering.  Also since the DESCRIPTION breaks up the
first form in the SYNOPSIS into two different forms (one without the
optional [<commit>], and the other with it), reorder to make these two
forms appear together.

Signed-off-by: Ramkumar Ramachandra <artagnon@gmail.com>
---
 Documentation/git-diff.txt | 18 +++++++++---------
 1 file changed, 9 insertions(+), 9 deletions(-)

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 291e250..1f2f681 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -10,12 +10,12 @@ SYNOPSIS
 --------
 [verse]
 'git diff' [options] [<commit>] [[--] [<path>...]]
+'git diff' [options] [--no-index] [[--] <path> <path>]
 'git diff' [options] --cached [<commit>] [[--] [<path>...]]
 'git diff' [options] <blob> <blob>
 'git diff' [options] <commit> <commit> [[--] [<path>...]]
 'git diff' [options] <commit>..<commit> [[--] [<path>...]]
 'git diff' [options] <commit>\...<commit> [[--] [<path>...]]
-'git diff' [options] [--no-index] [[--] <path> <path>]
 
 DESCRIPTION
 -----------
@@ -35,6 +35,14 @@ If exactly two paths are given and at least one points outside
 the current repository, 'git diff' will compare the two files /
 directories. This behavior can be forced by --no-index.
 
+'git diff' [options] <commit> [[--] [<path>...]]::
+
+	This form is to view the changes you have in your
+	working tree relative to the named <commit>.  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] --cached [<commit>] [[--] [<path>...]]::
 
 	This form is to view the changes you staged for the next
@@ -45,14 +53,6 @@ directories. This behavior can be forced by --no-index.
 	<commit> is not given, it shows all staged changes.
 	--staged is a synonym of --cached.
 
-'git diff' [options] <commit> [[--] [<path>...]]::
-
-	This form is to view the changes you have in your
-	working tree relative to the named <commit>.  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] <blob> <blob>::
 
 	This form is to view the differences between the raw
-- 
1.8.2.1.502.g2d60b5c

  parent reply	other threads:[~2013-04-24 16:33 UTC|newest]

Thread overview: 39+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2013-04-24 16:33 [PATCH 0/5] Documentation/git-diff.txt improvements Ramkumar Ramachandra
2013-04-24 16:33 ` [PATCH 1/5] git-diff.txt: reorder the <commit> <commit> form Ramkumar Ramachandra
2013-04-24 16:41   ` Jonathan Nieder
2013-04-24 16:33 ` [PATCH 2/5] git-diff.txt: strip the leading "--" from options template Ramkumar Ramachandra
2013-04-24 16:43   ` Jonathan Nieder
2013-04-24 16:44     ` Ramkumar Ramachandra
2013-04-24 18:15       ` Junio C Hamano
2013-04-24 16:33 ` [PATCH 3/5] git-diff.txt: group the [--] and [<path>...] templates Ramkumar Ramachandra
2013-04-24 18:20   ` Junio C Hamano
2013-04-24 18:23     ` Ramkumar Ramachandra
2013-04-24 18:43       ` Junio C Hamano
2013-04-24 18:53         ` Ramkumar Ramachandra
2013-04-24 19:21           ` Junio C Hamano
2013-04-24 19:24             ` Ramkumar Ramachandra
2013-04-24 18:57       ` Jonathan Nieder
2013-04-24 16:33 ` [PATCH 4/5] git-diff.txt: document the .. and ... forms in SYNOPSIS Ramkumar Ramachandra
2013-04-24 19:03   ` Jonathan Nieder
2013-04-24 16:33 ` Ramkumar Ramachandra [this message]
2013-04-24 18:25   ` [PATCH 5/5] git-diff.txt: fix ordering of the [--no-index] form Junio C Hamano
2013-04-24 18:29     ` Ramkumar Ramachandra
2013-04-24 19:06       ` Jonathan Nieder
2013-04-24 19:10         ` Ramkumar Ramachandra
2013-04-24 19:14           ` Jonathan Nieder
2013-04-24 19:20             ` Ramkumar Ramachandra
2013-04-24 19:25               ` Jonathan Nieder
2013-04-24 19:37             ` Ramkumar Ramachandra
2013-04-24 20:37               ` Jonathan Nieder
2013-04-24 20:45                 ` Ramkumar Ramachandra
2013-04-24 20:50                   ` Jonathan Nieder
2013-04-24 20:55                     ` Ramkumar Ramachandra
2013-04-24 17:03 ` [PATCH 6/5] git-diff.txt: banish the <commit>..<commit> form Ramkumar Ramachandra
2013-04-24 18:29   ` Junio C Hamano
2013-04-24 18:33     ` Ramkumar Ramachandra
2013-04-25 11:25 ` [PATCH 0/5] Documentation/git-diff.txt improvements Ramkumar Ramachandra
2013-04-29 16:33   ` Junio C Hamano
2013-04-29 17:19     ` Ramkumar Ramachandra
2013-04-29 17:40       ` Junio C Hamano
2013-04-29 18:28         ` Ramkumar Ramachandra
2013-04-29 18:46           ` Junio C Hamano

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=1366821216-20868-6-git-send-email-artagnon@gmail.com \
    --to=artagnon@gmail.com \
    --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).