grep: update docs to reflect new --all-files default
These docs no longer even mention the old weird behaviour that was
poorly understood and underutilised. I think this undocumentation
effectively deprecates it.
--- a/mercurial/commands.py Sun Oct 06 11:06:10 2019 -0400
+++ b/mercurial/commands.py Fri Oct 18 11:18:41 2019 -0400
@@ -3276,7 +3276,7 @@
b'diff',
None,
_(
- b'print all revisions when the term was introduced '
+ b'search revision differences for when the pattern was added '
b'or removed'
),
),
@@ -3302,7 +3302,7 @@
b'r',
b'rev',
[],
- _(b'only search files changed within revision range'),
+ _(b'search files changed within revision range'),
_(b'REV'),
),
(
@@ -3324,23 +3324,27 @@
intents={INTENT_READONLY},
)
def grep(ui, repo, pattern, *pats, **opts):
- """search revision history for a pattern in specified files
-
- Search revision history for a regular expression in the specified
- files or the entire project.
-
- By default, grep prints the most recent revision number for each
- file in which it finds a match. To get it to print every revision
- that contains a change in match status ("-" for a match that becomes
- a non-match, or "+" for a non-match that becomes a match), use the
- --diff flag.
+ """search for a pattern in specified files
+
+ Search the working directory or revision history for a regular
+ expression in the specified files for the entire repository.
+
+ By default, grep searches the repository files in the working
+ directory and prints the files where it finds a match. To specify
+ historical revisions instead of the working directory, use the
+ --rev flag.
+
+ To search instead historical revision differences that contains a
+ change in match status ("-" for a match that becomes a non-match,
+ or "+" for a non-match that becomes a match), use the --diff flag.
PATTERN can be any Python (roughly Perl-compatible) regular
expression.
- If no FILEs are specified (and -f/--follow isn't set), all files in
- the repository are searched, including those that don't exist in the
- current branch or have been deleted in a prior changeset.
+ If no FILEs are specified and the --rev flag isn't supplied, all
+ files in the working directory are searched. When using the --rev
+ flag and specifying FILEs, use the --follow argument to also
+ follow the specified FILEs across renames and copies.
.. container:: verbose
@@ -3363,6 +3367,7 @@
See :hg:`help templates.operators` for the list expansion syntax.
Returns 0 if a match is found, 1 otherwise.
+
"""
opts = pycompat.byteskwargs(opts)
diff = opts.get(b'all') or opts.get(b'diff')
--- a/tests/test-globalopts.t Sun Oct 06 11:06:10 2019 -0400
+++ b/tests/test-globalopts.t Fri Oct 18 11:18:41 2019 -0400
@@ -336,7 +336,7 @@
cat output the current or given revision of files
copy mark files as copied for the next commit
diff diff repository (or selected files)
- grep search revision history for a pattern in specified files
+ grep search for a pattern in specified files
Change navigation:
@@ -468,7 +468,7 @@
cat output the current or given revision of files
copy mark files as copied for the next commit
diff diff repository (or selected files)
- grep search revision history for a pattern in specified files
+ grep search for a pattern in specified files
Change navigation:
--- a/tests/test-help-hide.t Sun Oct 06 11:06:10 2019 -0400
+++ b/tests/test-help-hide.t Fri Oct 18 11:18:41 2019 -0400
@@ -40,7 +40,7 @@
cat output the current or given revision of files
copy mark files as copied for the next commit
diff diff repository (or selected files)
- grep search revision history for a pattern in specified files
+ grep search for a pattern in specified files
Change navigation:
@@ -176,7 +176,7 @@
cat output the current or given revision of files
copy mark files as copied for the next commit
diff diff repository (or selected files)
- grep search revision history for a pattern in specified files
+ grep search for a pattern in specified files
Change navigation:
--- a/tests/test-help.t Sun Oct 06 11:06:10 2019 -0400
+++ b/tests/test-help.t Fri Oct 18 11:18:41 2019 -0400
@@ -92,7 +92,7 @@
cat output the current or given revision of files
copy mark files as copied for the next commit
diff diff repository (or selected files)
- grep search revision history for a pattern in specified files
+ grep search for a pattern in specified files
Change navigation:
@@ -220,7 +220,7 @@
cat output the current or given revision of files
copy mark files as copied for the next commit
diff diff repository (or selected files)
- grep search revision history for a pattern in specified files
+ grep search for a pattern in specified files
Change navigation:
@@ -2590,7 +2590,7 @@
grep
</a>
</td><td>
- search revision history for a pattern in specified files
+ search for a pattern in specified files
</td></tr>
<tr><td>
<a href="/help/hashelp">
--- a/tests/test-hgweb-json.t Sun Oct 06 11:06:10 2019 -0400
+++ b/tests/test-hgweb-json.t Fri Oct 18 11:18:41 2019 -0400
@@ -2005,7 +2005,7 @@
"topic": "graft"
},
{
- "summary": "search revision history for a pattern in specified files",
+ "summary": "search for a pattern in specified files",
"topic": "grep"
},
{