git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
* [PATCH] diff: Document --staged over --cached
@ 2014-02-08  5:42 Soren Brinkmann
  0 siblings, 0 replies; only message in thread
From: Soren Brinkmann @ 2014-02-08  5:42 UTC (permalink / raw)
  To: git; +Cc: Soren Brinkmann

Since recent documentation uses terms like 'staged' and 'staging area',
--staged is more in line with other documentation and to be pfeferred
over --cached.

Signed-off-by: Soren Brinkmann <soren.brinkmann@xilinx.com>
---
 Documentation/git-diff.txt | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/git-diff.txt b/Documentation/git-diff.txt
index 33fbd8c56f91..12d5b62e71f9 100644
--- a/Documentation/git-diff.txt
+++ b/Documentation/git-diff.txt
@@ -10,7 +10,7 @@ SYNOPSIS
 --------
 [verse]
 'git diff' [options] [<commit>] [--] [<path>...]
-'git diff' [options] --cached [<commit>] [--] [<path>...]
+'git diff' [options] --staged [<commit>] [--] [<path>...]
 'git diff' [options] <commit> <commit> [--] [<path>...]
 'git diff' [options] <blob> <blob>
 'git diff' [options] [--no-index] [--] <path> <path>
@@ -38,7 +38,7 @@ two blob objects, or changes between two files on disk.
 	or when running the command outside a working tree
 	controlled by Git.
 
-'git diff' [--options] --cached [<commit>] [--] [<path>...]::
+'git diff' [--options] --staged [<commit>] [--] [<path>...]::
 
 	This form is to view the changes you staged for the next
 	commit relative to the named <commit>.  Typically you
@@ -46,7 +46,7 @@ two blob objects, or changes between two files on disk.
 	do not give <commit>, it defaults to HEAD.
 	If HEAD does not exist (e.g. unborned branches) and
 	<commit> is not given, it shows all staged changes.
-	--staged is a synonym of --cached.
+	--cached is a synonym of --staged.
 
 'git diff' [--options] <commit> [--] [<path>...]::
 
-- 
1.8.5.4

^ permalink raw reply related	[flat|nested] only message in thread

only message in thread, other threads:[~2014-02-08  5:42 UTC | newest]

Thread overview: (only message) (download: mbox.gz follow: Atom feed
-- links below jump to the message on this page --
2014-02-08  5:42 [PATCH] diff: Document --staged over --cached Soren Brinkmann

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).