{"thread":{"id":"22830","subject":"[PATCH 1/4] grep docs: pluralize \"Example\" section","startedAt":"2010-02-26T03:40:09Z","lastAt":"2010-02-26T22:07:48Z","messageCount":7,"participants":["Mark Lodato","Junio C Hamano"],"isPatch":true,"patchVersion":1,"patchTotal":4},"messages":[{"id":"135723","messageId":"1267155613-22134-1-git-send-email-lodatom@gmail.com","threadId":"22830","inReplyTo":null,"subject":"[PATCH 0/4] git-grep documentation updates","fromName":"Mark Lodato","fromEmail":"lodatom@gmail.com","sentAt":"2010-02-26T03:40:09Z","receivedAt":"2010-02-26T03:40:09Z","isPatch":true,"sender":{"key":"lodatom@gmail.com","avatar":"https://avatars.githubusercontent.com/u/58860?v=4"},"body":"This patch series contains some small changes to git-grep.txt. It is\nbased on my previous \"grep documentation: clarify what files match\",\ncommitted to master as 3ac44408. I posted these as four separate\npatches to document each change individually, but they could be squashed\ninto one if that is preferable.\n\nMark Lodato (4):\n grep docs: pluralize \"Example\" section\n grep docs: use AsciiDoc literals consistently\n grep docs: --cached and ... are incompatible\n grep docs: document --no-index option\n\n Documentation/git-grep.txt | 30 +++++++++++++++++-------------\n 1 files changed, 17 insertions(+), 13 deletions(-)\n"},{"id":"135719","messageId":"1267155613-22134-2-git-send-email-lodatom@gmail.com","threadId":"22830","inReplyTo":"1267155613-22134-1-git-send-email-lodatom@gmail.com","subject":"[PATCH 1/4] grep docs: pluralize \"Example\" section","fromName":"Mark Lodato","fromEmail":"lodatom@gmail.com","sentAt":"2010-02-26T03:40:10Z","receivedAt":"2010-02-26T03:40:10Z","isPatch":true,"sender":{"key":"lodatom@gmail.com","avatar":"https://avatars.githubusercontent.com/u/58860?v=4"},"body":"Signed-off-by: Mark Lodato \n---\n Documentation/git-grep.txt | 4 ++--\n 1 files changed, 2 insertions(+), 2 deletions(-)\n\ndiff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt\nindex c44724d..ae663b0 100644\n--- a/Documentation/git-grep.txt\n+++ b/Documentation/git-grep.txt\n@@ -174,8 +174,8 @@ OPTIONS\n \tIf given, limit the search to paths matching at least one pattern.\n \tBoth leading paths match and glob(7) patterns are supported.\n \n-Example\n--------\n+Examples\n+--------\n \n git grep 'time_t' -- '*.[ch]'::\n \tLooks for `time_t` in all tracked .c and .h files in the working\n-- \n1.7.0\n"},{"id":"135720","messageId":"1267155613-22134-3-git-send-email-lodatom@gmail.com","threadId":"22830","inReplyTo":"1267155613-22134-1-git-send-email-lodatom@gmail.com","subject":"[PATCH 2/4] grep docs: use AsciiDoc literals consistently","fromName":"Mark Lodato","fromEmail":"lodatom@gmail.com","sentAt":"2010-02-26T03:40:11Z","receivedAt":"2010-02-26T03:40:11Z","isPatch":true,"sender":{"key":"lodatom@gmail.com","avatar":"https://avatars.githubusercontent.com/u/58860?v=4"},"body":"The convention for this particular page is to use AsciiDoc literal\nstrings only for options (`-x` or `--long`), but not for definition list\nterms and not for .\n\nSigned-off-by: Mark Lodato \n---\n Documentation/git-grep.txt | 10 +++++-----\n 1 files changed, 5 insertions(+), 5 deletions(-)\n\ndiff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt\nindex ae663b0..2e16130 100644\n--- a/Documentation/git-grep.txt\n+++ b/Documentation/git-grep.txt\n@@ -98,8 +98,8 @@ OPTIONS\n --files-without-match::\n \tInstead of showing every matched line, show only the\n \tnames of files that contain (or do not contain) matches.\n-\tFor better compatibility with 'git diff', --name-only is a\n-\tsynonym for --files-with-matches.\n+\tFor better compatibility with 'git diff', `--name-only` is a\n+\tsynonym for `--files-with-matches`.\n \n -z::\n --null::\n@@ -125,7 +125,7 @@ OPTIONS\n \tmatches.\n \n -::\n-\tA shortcut for specifying -C.\n+\tA shortcut for specifying `-C`.\n \n -p::\n --show-function::\n@@ -140,7 +140,7 @@ OPTIONS\n \n -e::\n \tThe next parameter is the pattern. This option has to be\n-\tused for patterns starting with - and should be used in\n+\tused for patterns starting with `-` and should be used in\n \tscripts passing user input to grep. Multiple patterns are\n \tcombined by 'or'.\n \n@@ -163,7 +163,7 @@ OPTIONS\n \tDo not output matched lines; instead, exit with status 0 when\n \tthere is a match and with non-zero status when there isn't.\n \n-`...`::\n+...::\n \tSearch blobs in the trees for specified patterns.\n \n \\--::\n-- \n1.7.0\n"},{"id":"135721","messageId":"1267155613-22134-4-git-send-email-lodatom@gmail.com","threadId":"22830","inReplyTo":"1267155613-22134-1-git-send-email-lodatom@gmail.com","subject":"[PATCH 3/4] grep docs: --cached and ... are incompatible","fromName":"Mark Lodato","fromEmail":"lodatom@gmail.com","sentAt":"2010-02-26T03:40:12Z","receivedAt":"2010-02-26T03:40:12Z","isPatch":true,"sender":{"key":"lodatom@gmail.com","avatar":"https://avatars.githubusercontent.com/u/58860?v=4"},"body":"In the synopsis for git-grep(1), show that --cached and ... cannot\nbe used together.\n\nSigned-off-by: Mark Lodato \n---\nOne downside to this change is that having --cached makes it prominent, which\nis good since it's a very common option. However, I think accuracy is more\nimportant here.\n\n Documentation/git-grep.txt | 6 +++---\n 1 files changed, 3 insertions(+), 3 deletions(-)\n\ndiff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt\nindex 2e16130..37ce943 100644\n--- a/Documentation/git-grep.txt\n+++ b/Documentation/git-grep.txt\n@@ -9,8 +9,7 @@ git-grep - Print lines matching a pattern\n SYNOPSIS\n --------\n [verse]\n-'git grep' [--cached]\n-\t [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]\n+'git grep' [-a | --text] [-I] [-i | --ignore-case] [-w | --word-regexp]\n \t [-v | --invert-match] [-h|-H] [--full-name]\n \t [-E | --extended-regexp] [-G | --basic-regexp]\n \t [-F | --fixed-strings] [-n]\n@@ -21,7 +20,8 @@ SYNOPSIS\n \t [--color | --no-color]\n \t [-A ] [-B ] [-C ]\n \t [-f ] [-e] \n-\t [--and|--or|--not|(|)|-e ...] [...]\n+\t [--and|--or|--not|(|)|-e ...]\n+\t [--cached | ...]\n \t [--] [...]\n \n DESCRIPTION\n-- \n1.7.0\n"},{"id":"135722","messageId":"1267155613-22134-5-git-send-email-lodatom@gmail.com","threadId":"22830","inReplyTo":"1267155613-22134-1-git-send-email-lodatom@gmail.com","subject":"[PATCH 4/4] grep docs: document --no-index option","fromName":"Mark Lodato","fromEmail":"lodatom@gmail.com","sentAt":"2010-02-26T03:40:13Z","receivedAt":"2010-02-26T03:40:13Z","isPatch":true,"sender":{"key":"lodatom@gmail.com","avatar":"https://avatars.githubusercontent.com/u/58860?v=4"},"body":"Also clarify --cached and .\n\nSigned-off-by: Mark Lodato \n---\n Documentation/git-grep.txt | 12 ++++++++----\n 1 files changed, 8 insertions(+), 4 deletions(-)\n\ndiff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt\nindex 37ce943..86d7401 100644\n--- a/Documentation/git-grep.txt\n+++ b/Documentation/git-grep.txt\n@@ -21,7 +21,7 @@ SYNOPSIS\n \t [-A ] [-B ] [-C ]\n \t [-f ] [-e] \n \t [--and|--or|--not|(|)|-e ...]\n-\t [--cached | ...]\n+\t [--cached | --no-index | ...]\n \t [--] [...]\n \n DESCRIPTION\n@@ -33,8 +33,11 @@ registered in the index file, or blobs in given tree objects.\n OPTIONS\n -------\n --cached::\n-\tInstead of searching in the working tree files, check\n-\tthe blobs registered in the index file.\n+\tInstead of searching tracked files in the working tree, search\n+\tblobs registered in the index file.\n+\n+--no-index::\n+\tSearch all files in the working tree, not just those tracked by git.\n \n -a::\n --text::\n@@ -164,7 +167,8 @@ OPTIONS\n \tthere is a match and with non-zero status when there isn't.\n \n ...::\n-\tSearch blobs in the trees for specified patterns.\n+\tInstead of searching tracked files in the working tree, search\n+\tblobs in the given trees.\n \n \\--::\n \tSignals the end of options; the rest of the parameters\n-- \n1.7.0\n"},{"id":"135730","messageId":"7vocjceg0y.fsf@alter.siamese.dyndns.org","threadId":"22830","inReplyTo":"1267155613-22134-5-git-send-email-lodatom@gmail.com","subject":"Re: [PATCH 4/4] grep docs: document --no-index option","fromName":"Junio C Hamano","fromEmail":"gitster@pobox.com","sentAt":"2010-02-26T05:13:01Z","receivedAt":"2010-02-26T05:13:01Z","isPatch":true,"sender":{"key":"gitster@pobox.com","avatar":"https://avatars.githubusercontent.com/u/54884?v=4"},"body":"Mark Lodato writes:\n\n> +--no-index::\n> +\tSearch all files in the working tree, not just those tracked by git.\n\nI gave a quick glance to all four patches. Everything other than this\nlooked fine.\n\nThis one is meant to be usable outside git directory, and saying \"the\nworking tree\" is misleading. The \"work tree\" is a technical term that\nspecifically means the files in the directory hierarchy on the filesystem\nthat correspond to the index entries that represent them.\n\nIt probably should say \"the current directory\" or something here.\n"},{"id":"135781","messageId":"ca433831002261407l4d708283m5129c582a55fb1b6@mail.gmail.com","threadId":"22830","inReplyTo":"7vocjceg0y.fsf@alter.siamese.dyndns.org","subject":"Re: [PATCH 4/4] grep docs: document --no-index option","fromName":"Mark Lodato","fromEmail":"lodatom@gmail.com","sentAt":"2010-02-26T22:07:48Z","receivedAt":"2010-02-26T22:07:48Z","isPatch":true,"sender":{"key":"lodatom@gmail.com","avatar":"https://avatars.githubusercontent.com/u/58860?v=4"},"body":"On Fri, Feb 26, 2010 at 12:13 AM, Junio C Hamano wrote:\n> Mark Lodato writes:\n>\n>> +--no-index::\n>> +     Search all files in the working tree, not just those tracked by git.\n>\n> This one is meant to be usable outside git directory, and saying \"the\n> working tree\" is misleading.  The \"work tree\" is a technical term that\n> specifically means the files in the directory hierarchy on the filesystem\n> that correspond to the index entries that represent them.\n>\n> It probably should say \"the current directory\" or something here.\n\nHere's a squashable commit to do just that.\n\n---\n Documentation/git-grep.txt | 3 ++-\n 1 files changed, 2 insertions(+), 1 deletions(-)\n\ndiff --git a/Documentation/git-grep.txt b/Documentation/git-grep.txt\nindex 86d7401..3e6eaf7 100644\n--- a/Documentation/git-grep.txt\n+++ b/Documentation/git-grep.txt\n@@ -37,7 +37,8 @@ OPTIONS\n blobs registered in the index file.\n\n --no-index::\n- Search all files in the working tree, not just those tracked by git.\n+ Search all files in the current directory, not just those tracked\n+ by git.\n\n -a::\n --text::\n-- \n1.7.0\n"}]}