Documentation: add missing quotes to "git grep" examples
authorJonathan Nieder <jrnieder@gmail.com>
Fri, 20 Aug 2010 10:28:53 +0000 (05:28 -0500)
committerJunio C Hamano <gitster@pobox.com>
Fri, 20 Aug 2010 21:16:21 +0000 (14:16 -0700)
Without an indication to the contrary, Asciidoc puts 'quoted
text' in italics, making the output look like this:

git grep time_t -- *.[ch]
    Looks for time_t in all tracked .c and .h
    files in the working directory and its subdirectories.

git grep -e '#define\' --and \( -e MAX_PATH -e PATH_MAX \)
    Looks for a line that has #define and either MAX_PATH or
    PATH_MAX.

In the first example, the *.[ch] argument needs to be protected from
the shell, or else it will only match files in the current directory.
The second example has a stray backslash.

Reported-by: Frédéric Brière <fbriere@fbriere.net>
Cc: Mark Lodato <lodatom@gmail.com>
Cc: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Jonathan Nieder <jrnieder@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-grep.txt

index 5474dd7f94c4b3217230808e656662d0edcef207..dab0a78fa890d0c0cd193d89b7f4ac9ed19fb001 100644 (file)
@@ -191,11 +191,11 @@ OPTIONS
 Examples
 --------
 
-git grep 'time_t' \-- '*.[ch]'::
+git grep {apostrophe}time_t{apostrophe} \-- {apostrophe}*.[ch]{apostrophe}::
        Looks for `time_t` in all tracked .c and .h files in the working
        directory and its subdirectories.
 
-git grep -e \'#define\' --and \( -e MAX_PATH -e PATH_MAX \)::
+git grep -e {apostrophe}#define{apostrophe} --and \( -e MAX_PATH -e PATH_MAX \)::
        Looks for a line that has `#define` and either `MAX_PATH` or
        `PATH_MAX`.