New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update docs to explain use of -g and --files to search for paths. #285
Merged
BurntSushi
merged 2 commits into
BurntSushi:master
from
YPCrumble:update_docs_for_path_search
Dec 22, 2016
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -52,6 +52,14 @@ Project home page: https://github.com/BurntSushi/ripgrep | |
overrides any other ignore logic. Multiple glob flags may be used. Globbing | ||
rules match .gitignore globs. Precede a glob with a '!' to exclude it. | ||
|
||
Values given to -g must be quoted or your shell will expand them and result | ||
in unexpected behavior. | ||
|
||
Combine with the --files flag to return matched filenames | ||
(i.e., to replicate ack/ag's -g flag). | ||
|
||
For example: rg -g '<pattern>' --files | ||
|
||
-h, --help | ||
: Show this usage message. | ||
|
||
|
@@ -136,6 +144,10 @@ Project home page: https://github.com/BurntSushi/ripgrep | |
--files | ||
: Print each file that would be searched (but don't search). | ||
|
||
Combine with the -g flag to return matched paths, for example: | ||
|
||
rg -g '<pattern>' --files | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. As above, change this to |
||
|
||
-l, --files-with-matches | ||
: Only show path of each file with matches. | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Can you change
<pattern>
to<glob>
? I ask because I think we use<pattern>
elsewhere to refer to "regex pattern."