FreeBSD Bugzilla – Bug 154494
rcorder(8) not quite accurate
Last modified: 2011-08-10 01:19:54 UTC
The manpage for rcorder states: "The format of the lines is rigid. Each line must begin with a single `#', followed by a single space, followed by ``PROVIDE:'', ``REQUIRE:'', ``BEFORE:'', or ``KEYWORD:''. No deviation is permitted."
That is not entirely correct, as "PROVIDES:", "REQUIRES:" and "KEYWORDS:" are also allowed.
Found this on 8.1 but -current has the same manpage.
Fix: Patch attached with submission follows:
Date: Mon Jun 6 13:13:48 2011
New Revision: 222751
Document that REQUIRES, PROVIDES and KEYWORDS are alos accepted. This
chnage is different to the one suggested in the PR to try to avoid
cluttering the man page too much.
Submitted by: kilian <kilian.klimek googlemail.com>
MFC after: 1 week
--- head/sbin/rcorder/rcorder.8 Mon Jun 6 13:12:56 2011 (r222750)
+++ head/sbin/rcorder/rcorder.8 Mon Jun 6 13:13:48 2011 (r222751)
@@ -89,6 +89,12 @@ and
lines may appear, but all such lines must appear in a sequence without
any intervening lines, as once a line that does not follow the format
is reached, parsing stops.
+Note that for historical reasons,
+.Dq Li REQUIRES ,
+.Dq Li PROVIDES ,
+.Dq Li KEYWORDS
+are also accepted in addition to the above.
The options are as follows:
.Bl -tag -width indent
email@example.com mailing list
To unsubscribe, send any mail to "firstname.lastname@example.org"
Fix committed to head, MFC in one week.
I wish that you had discussed this with freebsd-rc@ before committing.
:-/ I can't see any good thing that comes from documenting this. OTOH,
the benefit of not documenting it is that eventually we can remove
support for the un-documented versions because they are no longer used.
Is there something that I'm missing?
On 06/06/2011 06:14, gavin@FreeBSD.org wrote:
> Synopsis: rcorder(8) not quite accurate
> State-Changed-From-To: open->patched
> State-Changed-By: gavin
> State-Changed-When: Mon Jun 6 13:14:10 UTC 2011
> Fix committed to head, MFC in one week.
> Responsible-Changed-From-To: freebsd-doc->gavin
> Responsible-Changed-By: gavin
> Responsible-Changed-When: Mon Jun 6 13:14:10 UTC 2011
Nothin' ever doesn't change, but nothin' changes much.
-- OK Go
Breadth of IT experience, and depth of knowledge in the DNS.
Yours for the right price. :) http://SupersetSolutions.com/
On Mon, 6 Jun 2011, Doug Barton wrote:
> I wish that you had discussed this with freebsd-rc@ before committing. :-/ I
> can't see any good thing that comes from documenting this. OTOH, the benefit
> of not documenting it is that eventually we can remove support for the
> un-documented versions because they are no longer used.
I must admit that I was a little surprised to see the man page be so
explicit in saying that no other keywords were accepted, and yet the
rcorder(8) code accepts them happily.
I wasn't happy with the patch submitted in the PR for a number of reasons,
but I felt that my rewording made it clear that these were accepted only
historically, and therefore not suggested for use in new scripts. I tried
to get the balance correct between documenting behaviour, and discouraging
the use of deprecated features.
I'm happy to revert this if you think these should remain deliberately
The change to include this information in the comments,
as opposed to the body of the text has now been MFC'ed
I did the change, so I own the pointy hats.