Document what happens when you don't have any dependency lines in a

file, and downgrade "must" to "should" in a couple of places.
Answers a documentation complaint from Jeremy C. Reed in PR misc/21251
This commit is contained in:
perry 2003-04-24 03:15:45 +00:00
parent 5116f9caae
commit b23b1bcc57

View File

@ -1,4 +1,4 @@
.\" $NetBSD: rcorder.8,v 1.5 2002/10/03 15:41:44 wiz Exp $
.\" $NetBSD: rcorder.8,v 1.6 2003/04/24 03:15:45 perry Exp $
.\"
.\" Copyright (c) 1998
.\" Perry E. Metzger. All rights reserved.
@ -30,7 +30,7 @@
.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
.\"
.\"
.Dd July 17, 2000
.Dd April 23, 2003
.Dt RCORDER 8
.Os
.Sh NAME
@ -50,7 +50,7 @@ shell scripts in which certain files must be executed before others.
.Pp
Each file passed to
.Nm
must be annotated with special lines (which look like comments to the
should be annotated with special lines (which look like comments to the
shell) which indicate the dependencies the files have upon certain
points in the sequence, known as
.Dq conditions ,
@ -64,7 +64,7 @@ Within each file, a block containing a series of
.Dq BEFORE
and
.Dq KEYWORD
lines must appear.
lines should appear.
The format of the lines is rigid.
Each line must begin with a single
.Dq # ,
@ -126,6 +126,14 @@ A file may contain zero
lines, in which case it provides no conditions, and may contain zero
.Dq REQUIRE
lines, in which case it has no dependencies.
A file containing no
.Dq PROVIDE ,
.Dq REQUIRE ,
or
.Dq BEFORE
lines may be output at an arbitrary position in the dependency
ordering.
.Pp
There must be at least one file with no dependencies in the set of
arguments passed to
.Nm