lostecho/ripgrep
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

doc: overhaul documentation

Browse Source 
This commit cleans up the README and splits portions of it out into
a user guide (GUIDE.md) and a FAQ (FAQ.md). The README now provides a
small list of documentation "quick" links to various parts of the docs.

This commit also does a few other minor touchups.
This commit is contained in:
Andrew Gallant
2018-02-06 18:49:30 -05:00
parent ca3e0e8a49
commit 904c75bd30
6 changed files with 1144 additions and 369 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/app.rs
View File

@@ -13,15 +13,13 @@ use clap::{self, App, AppSettings};
const ABOUT: &str = "
ripgrep (rg) recursively searches your current directory for a regex pattern.
By default, ripgrep will respect your `.gitignore` and automatically skip
hidden files/directories and binary files.
ripgrep's regex engine uses finite automata and guarantees linear time
searching. Because of this, features like backreferences and arbitrary
lookaround are not supported.
Note that ripgrep may abort unexpectedly when using default settings if it
searches a file that is simultaneously truncated. This behavior can be avoided
by passing the --no-mmap flag.
ripgrep supports configuration files. Set RIPGREP_CONFIG_PATH to a
configuration file. The file can specify one shell argument per line. Lines
starting with '#' are ignored. For more details, see the man page or the
@@ -857,9 +855,9 @@ fn flag_files_without_match(args: &mut Vec<RGArg>) {
const SHORT: &str = "Only print the paths that contain zero matches.";
const LONG: &str = long!("\
Only print the paths that contain zero matches. This inverts/negates the
--file-with-matches flag.
--files-with-matches flag.
This overrides --file-with-matches.
This overrides --files-with-matches.
");
let arg = RGArg::switch("files-without-match")
.help(SHORT).long_help(LONG)
@@ -900,7 +898,7 @@ This flag can be disabled with --no-follow.
}
fn flag_glob(args: &mut Vec<RGArg>) {
const SHORT: &str = "Include or exclude files and directories.";
const SHORT: &str = "Include or exclude files.";
const LONG: &str = long!("\
Include or exclude files and directories for searching that match the given
glob. This always overrides any other ignore logic. Multiple glob flags may be
@@ -964,7 +962,7 @@ This flag can be disabled with --no-hidden.
fn flag_iglob(args: &mut Vec<RGArg>) {
const SHORT: &str =
"Include or exclude files and directories case insensitively.";
"Include or exclude files case insensitively.";
const LONG: &str = long!("\
Include or exclude files and directories for searching that match the given
glob. This always overrides any other ignore logic. Multiple glob flags may be