rust/ripgrep
1
0
Fork 0
mirror of https://github.com/BurntSushi/ripgrep.git synced 2025-04-19 09:02:15 +02:00
Code Issues Releases Activity

doc: improve wording

Browse Source 
This tightens up the wording in ripgrep's opening description. It's used
in several places, so we update all of them.

Closes #1881
This commit is contained in:
Varik Valefor 2021-05-30 03:03:40 -04:00 committed by Andrew Gallant
parent 5af7707a35
commit beda5f70dc
5 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
Cargo.toml
View File

@ -3,9 +3,9 @@ name = "ripgrep"
version = "12.1.1" #:version version = "12.1.1" #:version
authors = ["Andrew Gallant <jamslam@gmail.com>"] authors = ["Andrew Gallant <jamslam@gmail.com>"]
description = """ description = """
ripgrep is a line-oriented search tool that recursively searches your current ripgrep is a line-oriented search tool that recursively searches the current
directory for a regex pattern while respecting your gitignore rules. ripgrep directory for a regex pattern while respecting gitignore rules. ripgrep has
has first class support on Windows, macOS and Linux. first class support on Windows, macOS and Linux.
""" """
documentation = "https://github.com/BurntSushi/ripgrep" documentation = "https://github.com/BurntSushi/ripgrep"
homepage = "https://github.com/BurntSushi/ripgrep" homepage = "https://github.com/BurntSushi/ripgrep"

4
README.md
View File

@ -1,7 +1,7 @@
ripgrep (rg) ripgrep (rg)
------------ ------------
ripgrep is a line-oriented search tool that recursively searches your current ripgrep is a line-oriented search tool that recursively searches the current
directory for a regex pattern. By default, ripgrep will respect your .gitignore directory for a regex pattern. By default, ripgrep will respect gitignore rules
and automatically skip hidden files/directories and binary files. ripgrep and automatically skip hidden files/directories and binary files. ripgrep
has first class support on Windows, macOS and Linux, with binary downloads has first class support on Windows, macOS and Linux, with binary downloads
available for [every release](https://github.com/BurntSushi/ripgrep/releases). available for [every release](https://github.com/BurntSushi/ripgrep/releases).

6
RELEASE-CHECKLIST.md
View File

@ -29,9 +29,9 @@ Release Checklist
* Copy the relevant section of the CHANGELOG to the tagged release notes. * Copy the relevant section of the CHANGELOG to the tagged release notes.
Include this blurb describing what ripgrep is: Include this blurb describing what ripgrep is:
> In case you haven't heard of it before, ripgrep is a line-oriented search > 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. > tool that recursively searches the current directory for a regex pattern.
> By default, ripgrep will respect your gitignore rules and automatically > By default, ripgrep will respect gitignore rules and automatically skip
> skip hidden files/directories and binary files. > hidden files/directories and binary files.
* Run `ci/build-deb` locally and manually upload the deb package to the * Run `ci/build-deb` locally and manually upload the deb package to the
release. release.
* Run `cargo publish`. * Run `cargo publish`.

4
crates/core/app.rs
View File

@ -13,8 +13,8 @@ use clap::{self, crate_authors, crate_version, App, AppSettings};
use lazy_static::lazy_static; use lazy_static::lazy_static;
const ABOUT: &str = " const ABOUT: &str = "
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 By default, ripgrep will respect gitignore rules and automatically skip hidden
files/directories and binary files. files/directories and binary files.
Use -h for short descriptions and --help for more details. Use -h for short descriptions and --help for more details.

12
doc/rg.1.txt.tpl
View File

@ -3,7 +3,7 @@ rg(1)
Name Name
---- ----
rg - recursively search current directory for lines matching a pattern rg - recursively search the current directory for lines matching a pattern
Synopsis Synopsis
@ -27,7 +27,7 @@ Synopsis
DESCRIPTION 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 By default, ripgrep will respect your .gitignore and automatically skip hidden
files/directories and binary files. files/directories and binary files.
@ -82,10 +82,10 @@ _PATH_::
OPTIONS OPTIONS
------- -------
Note that for many options, there exist flags to disable them. In some cases, Note that many options can be disabled via flags. In some cases, those flags
those flags are not listed in a first class way below. For example, the are not listed in a first class way below. For example, the *--column*
*--column* flag (listed below) enables column numbers in ripgrep's output, but flag (listed below) enables column numbers in ripgrep's output, but the
the *--no-column* flag (not listed below) disables them. The reverse can also *--no-column* flag (not listed below) disables them. The reverse can also
exist. For example, the *--no-ignore* flag (listed below) disables ripgrep's exist. For example, the *--no-ignore* flag (listed below) disables ripgrep's
*gitignore* logic, but the *--ignore* flag (not listed below) enables it. These *gitignore* logic, but the *--ignore* flag (not listed below) enables it. These
flags are useful for overriding a ripgrep configuration file on the command flags are useful for overriding a ripgrep configuration file on the command