git/list[1] front-page[2] threads[3] people[4] search[5] about
 

[PATCH 3/4] grep docs: --cached and <tree>... are incompatible

From
Mark Lodato <lodatom@gmail.com>
Date
Feb 26, 2010, 03:40 UTC
Message-ID
<1267155613-22134-4-git-send-email-lodatom@gmail.com>
In-Reply-To
<1267155613-22134-1-git-send-email-lodatom@gmail.com>

In the synopsis for git-grep(1), show that --cached and <tree>... cannot be used together.

Signed-off-by: Mark Lodato <lodatom@gmail.com>
---
One downside to this change is that having --cached makes it prominent, which
is good since it's a very common option.  However, I think accuracy is more
important here.
 Documentation/git-grep.txt |    6 +++---
 1 files changed, 3 insertions(+), 3 deletions(-)
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index 2e16130..37ce943 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -9,8 +9,7 @@ git-grep - Print lines matching a pattern
 SYNOPSIS
 --------
 [verse]
-'git grep' [--cached]
-	   [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
+'git grep' [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]
 	   [-v | --invert-match] [-h|-H] [--full-name]
 	   [-E | --extended-regexp] [-G | --basic-regexp]
 	   [-F | --fixed-strings] [-n]
@@ -21,7 +20,8 @@ SYNOPSIS
 	   [--color | --no-color]
 	   [-A <post-context>] [-B <pre-context>] [-C <context>]
 	   [-f <file>] [-e] <pattern>
-	   [--and|--or|--not|(|)|-e <pattern>...] [<tree>...]
+	   [--and|--or|--not|(|)|-e <pattern>...]
+	   [--cached | <tree>...]
 	   [--] [<pathspec>...]
 
 DESCRIPTION
-- 
1.7.0
Previous: Mark LodatoNext: Mark Lodato
Message 4 of 7 in “git-grep documentation updates”
  1. 0/4 git-grep documentation updatesMark Lodato, Feb 26, 2010
  2. 1/4 grep docs: pluralize "Example" sectionMark Lodato, Feb 26, 2010
  3. 2/4 grep docs: use AsciiDoc literals consistentlyMark Lodato, Feb 26, 2010
  4. 3/4 grep docs: --cached and <tree>... are incompatibleMark Lodato, Feb 26, 2010
  5. 4/4 grep docs: document --no-index optionMark Lodato, Feb 26, 2010
  6. Junio C HamanoFeb 26, 2010
  7. Mark LodatoFeb 26, 2010

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.