Document that we don't read subdirectories when expanding *.rem.
Remind unit tests / tests (push) Successful in 31s

This commit is contained in:
Dianne Skoll
2024-12-06 20:21:09 -05:00
parent 087fbfd8e6
commit a933c8bc69
+11 -9
View File
@@ -14,11 +14,12 @@ If \fIfilename\fR is specified as a single dash '-', then \fBRemind\fR
takes its input from standard input. takes its input from standard input.
.PP .PP
If \fIfilename\fR happens to If \fIfilename\fR happens to be a directory rather than a plain file,
be a directory rather than a plain file, then \fBRemind\fR reads all of then \fBRemind\fR reads all of the files (but not any subdirectories!)
the files in that directory that match the pattern "*.rem". The files in that directory that match the pattern "*.rem". The files are read
are read in sorted order; the sort order may depend on your locale, but in sorted order; the sort order may depend on your locale, but should
should match the sort order used by the shell to expand "*.rem". match the sort order used by the shell to expand "*.rem".
.PP .PP
\fBRemind\fR reads its files starting from the beginning to the end, or \fBRemind\fR reads its files starting from the beginning to the end, or
until it encounters a line whose sole content is "__EOF__" (without the quotes.) until it encounters a line whose sole content is "__EOF__" (without the quotes.)
@@ -1925,10 +1926,11 @@ administrator.)
If you specify a filename of "-" in the \fBINCLUDE\fR command, \fBRemind\fR If you specify a filename of "-" in the \fBINCLUDE\fR command, \fBRemind\fR
will begin reading from standard input. will begin reading from standard input.
.PP .PP
If you specify a \fIdirectory\fR as the argument to \fBINCLUDE\fR, then If you specify a \fIdirectory\fR as the argument to \fBINCLUDE\fR,
\fBRemind\fR will process all files in that directory that match the shell then \fBRemind\fR will process all files (but not subdirectories!) in
pattern "*.rem". The files are processed in sorted order; the sort order that directory that match the shell pattern "*.rem". The files are
matches that used by the shell when it expands "*.rem". processed in sorted order; the sort order matches that used by the
shell when it expands "*.rem".
.PP .PP
Note that the file specified by an \fBINCLUDE\fR command is interpreted Note that the file specified by an \fBINCLUDE\fR command is interpreted
relative to the \fIcurrent working directory of the Remind process\fR. relative to the \fIcurrent working directory of the Remind process\fR.