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

[PATCH 2/4] grep docs: use AsciiDoc literals consistently

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

The convention for this particular page is to use AsciiDoc literal strings only for options (`-x` or `--long`), but not for definition list terms and not for <meta-vars>.

Signed-off-by: Mark Lodato <lodatom@gmail.com>
---
 Documentation/git-grep.txt |   10 +++++-----
 1 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt
index ae663b0..2e16130 100644
--- a/Documentation/git-grep.txt
+++ b/Documentation/git-grep.txt
@@ -98,8 +98,8 @@ OPTIONS
 --files-without-match::
 	Instead of showing every matched line, show only the
 	names of files that contain (or do not contain) matches.
-	For better compatibility with 'git diff', --name-only is a
-	synonym for --files-with-matches.
+	For better compatibility with 'git diff', `--name-only` is a
+	synonym for `--files-with-matches`.
 
 -z::
 --null::
@@ -125,7 +125,7 @@ OPTIONS
 	matches.
 
 -<num>::
-	A shortcut for specifying -C<num>.
+	A shortcut for specifying `-C<num>`.
 
 -p::
 --show-function::
@@ -140,7 +140,7 @@ OPTIONS
 
 -e::
 	The next parameter is the pattern. This option has to be
-	used for patterns starting with - and should be used in
+	used for patterns starting with `-` and should be used in
 	scripts passing user input to grep.  Multiple patterns are
 	combined by 'or'.
 
@@ -163,7 +163,7 @@ OPTIONS
 	Do not output matched lines; instead, exit with status 0 when
 	there is a match and with non-zero status when there isn't.
 
-`<tree>...`::
+<tree>...::
 	Search blobs in the trees for specified patterns.
 
 \--::
-- 
1.7.0
Previous: Mark LodatoNext: Mark Lodato
Message 3 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.