Skip to content

Commit 79cbe89

Browse files
committed
doc: tweak wording for stdin detection
This makes it slightly more precise to cover weird cases like trying to pass a directory on stdin. Closes #2906
1 parent bf63fe8 commit 79cbe89

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

crates/core/flags/doc/template.rg.1

+4-4
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,10 @@ configuration file. The file can specify one shell argument per line. Lines
4343
starting with \fB#\fP are ignored. For more details, see \fBCONFIGURATION
4444
FILES\fP below.
4545
.sp
46-
ripgrep will automatically detect if stdin exists and search stdin for a regex
47-
pattern, e.g. \fBls | rg foo\fP. In some environments, stdin may exist when
48-
it shouldn't. To turn off stdin detection, one can explicitly specify the
49-
directory to search, e.g. \fBrg foo ./\fP.
46+
ripgrep will automatically detect if stdin is a readable file and search stdin
47+
for a regex pattern, e.g. \fBls | rg foo\fP. In some environments, stdin may
48+
exist when it shouldn't. To turn off stdin detection, one can explicitly
49+
specify the directory to search, e.g. \fBrg foo ./\fP.
5050
.sp
5151
Like other tools such as \fBls\fP, ripgrep will alter its output depending on
5252
whether stdout is connected to a tty. By default, when printing a tty, ripgrep

0 commit comments

Comments
 (0)