twin/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-05-19 09:40:22 -07:00
Code Issues Packages Projects Releases Wiki Activity

doc: clarify --with-filename behavior with --heading

Browse Source
This commit is contained in:
Dan Fabulich 2017-09-06 02:34:57 -07:00 committed by Andrew Gallant
parent f9cbf7d3d4
commit beb010d004
4 changed files with 13 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
complete/_rg
View File

@ -80,7 +80,7 @@ _rg() {
'*'{-u,--unrestricted}'[reduce level of "smart" searching]' '*'{-u,--unrestricted}'[reduce level of "smart" searching]'
'(: -)'{-V,--version}'[display version information]' '(: -)'{-V,--version}'[display version information]'
'(-p --heading --no-heading --pretty)--vimgrep[show results in vim-compatible format]' '(-p --heading --no-heading --pretty)--vimgrep[show results in vim-compatible format]'
'(-H --no-filename --with-filename)'{-H,--with-filename}'[prefix each match with name of file that contains it]' '(-H --no-filename --with-filename)'{-H,--with-filename}'[display the file name for matches]'
'(-w -x --line-regexp --word-regexp)'{-w,--word-regexp}'[only show matches surrounded by word boundaries]' '(-w -x --line-regexp --word-regexp)'{-w,--word-regexp}'[only show matches surrounded by word boundaries]'
'(-e -f --file --files --regexp --type-list)1: :_rg_pattern' '(-e -f --file --files --regexp --type-list)1: :_rg_pattern'
'(--type-list)*:file:_files' '(--type-list)*:file:_files'

5
doc/rg.1
View File

@ -274,8 +274,11 @@ Only show path of each file with no matches.
.RE .RE
.TP .TP
.B \-H, \-\-with\-filename .B \-H, \-\-with\-filename
Prefix each match with the file name that contains it. Display the file name for matches.
This is the default when more than one file is searched. This is the default when more than one file is searched.
If \-\-heading is enabled, the file name will be shown above clusters of
matches from each file; otherwise, the file name will be shown on each
match.
.RS .RS
.RE .RE
.TP .TP

6
doc/rg.1.md
View File

@ -182,8 +182,10 @@ Project home page: https://github.com/BurntSushi/ripgrep
: Only show path of each file with no matches. : Only show path of each file with no matches.
-H, --with-filename -H, --with-filename
: Prefix each match with the file name that contains it. This is the : Display the file name for matches. This is the default when
default when more than one file is searched. more than one file is searched. If --heading is enabled, the
file name will be shown above clusters of matches from each
file; otherwise, the file name will be shown on each match.
--no-filename --no-filename
: Never show the filename for a match. This is the default when : Never show the filename for a match. This is the default when

6
src/app.rs
View File

@ -398,8 +398,10 @@ lazy_static! {
"Only show the paths that contains zero matches."); "Only show the paths that contains zero matches.");
doc!(h, "with-filename", doc!(h, "with-filename",
"Show file name for each match.", "Show file name for each match.",
"Prefix each match with the file name that contains it. This is \ "Display the file name for matches. This is the default when \
the default when more than one file is searched."); more than one file is searched. If --heading is enabled, the \
file name will be shown above clusters of matches from each \
file; otherwise, the file name will be shown on each match.");
doc!(h, "no-filename", doc!(h, "no-filename",
"Never show the file name for a match.", "Never show the file name for a match.",
"Never show the file name for a match. This is the default when \ "Never show the file name for a match. This is the default when \