summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorVarik Valefor <38414004+varikvalefor@users.noreply.github.com>2021-05-30 03:03:40 -0400
committerAndrew Gallant <jamslam@gmail.com>2021-05-31 21:51:18 -0400
commitbeda5f70dc12ffba383f2861461820de24816ef3 (patch)
treeb0a4529ea0da613d99905fd3c2580603b7fc7bbe
parent5af7707a350d96066c47965075b09050bc1cf33c (diff)
doc: improve wording
This tightens up the wording in ripgrep's opening description. It's used in several places, so we update all of them. Closes #1881
-rw-r--r--Cargo.toml6
-rw-r--r--README.md4
-rw-r--r--RELEASE-CHECKLIST.md6
-rw-r--r--crates/core/app.rs4
-rw-r--r--doc/rg.1.txt.tpl12
5 files changed, 16 insertions, 16 deletions
diff --git a/Cargo.toml b/Cargo.toml
index 5d6c83b1..4373560d 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -3,9 +3,9 @@ name = "ripgrep"
version = "12.1.1" #:version
authors = ["Andrew Gallant <jamslam@gmail.com>"]
description = """
-ripgrep is a line-oriented search tool that recursively searches your current
-directory for a regex pattern while respecting your gitignore rules. ripgrep
-has first class support on Windows, macOS and Linux.
+ripgrep is a line-oriented search tool that recursively searches the current
+directory for a regex pattern while respecting gitignore rules. ripgrep has
+first class support on Windows, macOS and Linux.
"""
documentation = "https://github.com/BurntSushi/ripgrep"
homepage = "https://github.com/BurntSushi/ripgrep"
diff --git a/README.md b/README.md
index 3ea9b636..18037a1b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,7 @@
ripgrep (rg)
------------
-ripgrep is a line-oriented search tool that recursively searches your current
-directory for a regex pattern. By default, ripgrep will respect your .gitignore
+ripgrep is a line-oriented search tool that recursively searches the current
+directory for a regex pattern. By default, ripgrep will respect gitignore rules
and automatically skip hidden files/directories and binary files. ripgrep
has first class support on Windows, macOS and Linux, with binary downloads
available for [every release](https://github.com/BurntSushi/ripgrep/releases).
diff --git a/RELEASE-CHECKLIST.md b/RELEASE-CHECKLIST.md
index 255708f3..c42bbd5d 100644
--- a/RELEASE-CHECKLIST.md
+++ b/RELEASE-CHECKLIST.md
@@ -29,9 +29,9 @@ Release Checklist
* Copy the relevant section of the CHANGELOG to the tagged release notes.
Include this blurb describing what ripgrep is:
> In case you haven't heard of it before, ripgrep is a line-oriented search
- > tool that recursively searches your current directory for a regex pattern.
- > By default, ripgrep will respect your gitignore rules and automatically
- > skip hidden files/directories and binary files.
+ > tool that recursively searches the current directory for a regex pattern.
+ > By default, ripgrep will respect gitignore rules and automatically skip
+ > hidden files/directories and binary files.
* Run `ci/build-deb` locally and manually upload the deb package to the
release.
* Run `cargo publish`.
diff --git a/crates/core/app.rs b/crates/core/app.rs
index 496eef38..cca35111 100644
--- a/crates/core/app.rs
+++ b/crates/core/app.rs
@@ -13,8 +13,8 @@ use clap::{self, crate_authors, crate_version, App, AppSettings};
use lazy_static::lazy_static;
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
+ripgrep (rg) recursively searches the current directory for a regex pattern.
+By default, ripgrep will respect gitignore rules and automatically skip hidden
files/directories and binary files.
Use -h for short descriptions and --help for more details.
diff --git a/doc/rg.1.txt.tpl b/doc/rg.1.txt.tpl
index aef86746..27f57dd8 100644
--- a/doc/rg.1.txt.tpl
+++ b/doc/rg.1.txt.tpl
@@ -3,7 +3,7 @@ rg(1)
Name
----
-rg - recursively search current directory for lines matching a pattern
+rg - recursively search the current directory for lines matching a pattern
Synopsis
@@ -27,7 +27,7 @@ Synopsis
DESCRIPTION
-----------
-ripgrep (rg) recursively searches your current directory for a regex pattern.
+ripgrep (rg) recursively searches the current directory for a regex pattern.
By default, ripgrep will respect your .gitignore and automatically skip hidden
files/directories and binary files.
@@ -82,10 +82,10 @@ _PATH_::
OPTIONS
-------
-Note that for many options, there exist flags to disable them. In some cases,
-those flags are not listed in a first class way below. For example, the
-*--column* flag (listed below) enables column numbers in ripgrep's output, but
-the *--no-column* flag (not listed below) disables them. The reverse can also
+Note that many options can be disabled via flags. In some cases, those flags
+are not listed in a first class way below. For example, the *--column*
+flag (listed below) enables column numbers in ripgrep's output, but the
+*--no-column* flag (not listed below) disables them. The reverse can also
exist. For example, the *--no-ignore* flag (listed below) disables ripgrep's
*gitignore* logic, but the *--ignore* flag (not listed below) enables it. These
flags are useful for overriding a ripgrep configuration file on the command