From nobody@FreeBSD.org  Thu Feb  3 22:35:16 2011
Return-Path: <nobody@FreeBSD.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34])
	by hub.freebsd.org (Postfix) with ESMTP id A4D78106566C
	for <freebsd-gnats-submit@FreeBSD.org>; Thu,  3 Feb 2011 22:35:16 +0000 (UTC)
	(envelope-from nobody@FreeBSD.org)
Received: from red.freebsd.org (red.freebsd.org [IPv6:2001:4f8:fff6::22])
	by mx1.freebsd.org (Postfix) with ESMTP id 951508FC12
	for <freebsd-gnats-submit@FreeBSD.org>; Thu,  3 Feb 2011 22:35:16 +0000 (UTC)
Received: from red.freebsd.org (localhost [127.0.0.1])
	by red.freebsd.org (8.14.4/8.14.4) with ESMTP id p13MZGmJ029401
	for <freebsd-gnats-submit@FreeBSD.org>; Thu, 3 Feb 2011 22:35:16 GMT
	(envelope-from nobody@red.freebsd.org)
Received: (from nobody@localhost)
	by red.freebsd.org (8.14.4/8.14.4/Submit) id p13MZGsw029400;
	Thu, 3 Feb 2011 22:35:16 GMT
	(envelope-from nobody)
Message-Id: <201102032235.p13MZGsw029400@red.freebsd.org>
Date: Thu, 3 Feb 2011 22:35:16 GMT
From: kilian <kilian.klimek@googlemail.com>
To: freebsd-gnats-submit@FreeBSD.org
Subject: rcorder(8) not quit accurate
X-Send-Pr-Version: www-3.1
X-GNATS-Notify:

>Number:         154494
>Category:       docs
>Synopsis:       rcorder(8) not quite accurate
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    dougb
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Thu Feb 03 22:40:08 UTC 2011
>Closed-Date:    Wed Aug 10 00:19:54 UTC 2011
>Last-Modified:  Wed Aug 10 00:19:54 UTC 2011
>Originator:     kilian
>Release:        8.1
>Organization:
>Environment:
>Description:
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.


>How-To-Repeat:

>Fix:


Patch attached with submission follows:

--- rcorder.8.orig	2011-02-03 23:21:35.000000000 +0100
+++ rcorder.8	2011-02-03 23:17:58.000000000 +0100
@@ -73,10 +73,13 @@
 .Ql # ,
 followed by a single space, followed by
 .Dq Li PROVIDE: ,
+.Dq Li PROVIDES: ,
 .Dq Li REQUIRE: ,
+.Dq Li REQUIRES: ,
 .Dq Li BEFORE: ,
-or
 .Dq Li KEYWORD: .
+or
+.Dq Li KEYWORDS: .
 No deviation is permitted.
 Each dependency line is then followed by a series of conditions,
 separated by whitespace.


>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->patched 
State-Changed-By: gavin 
State-Changed-When: Mon Jun 6 13:14:10 UTC 2011 
State-Changed-Why:  
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 
Responsible-Changed-Why:  
Mine 

http://www.freebsd.org/cgi/query-pr.cgi?pr=154494 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/154494: commit references a PR
Date: Mon,  6 Jun 2011 13:13:56 +0000 (UTC)

 Author: gavin
 Date: Mon Jun  6 13:13:48 2011
 New Revision: 222751
 URL: http://svn.freebsd.org/changeset/base/222751
 
 Log:
   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.
   
   PR:		docs/154494
   Submitted by:	kilian <kilian.klimek googlemail.com>
   MFC after:	1 week
 
 Modified:
   head/sbin/rcorder/rcorder.8
 
 Modified: head/sbin/rcorder/rcorder.8
 ==============================================================================
 --- 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 ,
 +and
 +.Dq Li KEYWORDS
 +are also accepted in addition to the above.
  .Pp
  The options are as follows:
  .Bl -tag -width indent
 _______________________________________________
 svn-src-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-src-all
 To unsubscribe, send any mail to "svn-src-all-unsubscribe@freebsd.org"
 

From: Doug Barton <dougb@FreeBSD.org>
To: gavin@FreeBSD.org
Cc: kilian.klimek@googlemail.com, freebsd-doc@FreeBSD.org, 
 bug-followup@FreeBSD.org, freebsd-rc@FreeBSD.org
Subject: Re: docs/154494: rcorder(8) not quite accurate
Date: Mon, 06 Jun 2011 13:41:30 -0700

 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?
 
 
 Doug
 
 
 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
 > State-Changed-Why:
 > 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
 > Responsible-Changed-Why:
 > Mine
 >
 > http://www.freebsd.org/cgi/query-pr.cgi?pr=154494
 
 
 
 -- 
 
 	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/
 

From: Gavin Atkinson <gavin@FreeBSD.org>
To: Doug Barton <dougb@FreeBSD.org>
Cc: kilian.klimek@googlemail.com, freebsd-doc@FreeBSD.org, 
    bug-followup@FreeBSD.org, freebsd-rc@FreeBSD.org
Subject: Re: docs/154494: rcorder(8) not quite accurate
Date: Thu, 9 Jun 2011 21:25:24 +0100 (BST)

 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 
 undocumented.
 
 Gavin
State-Changed-From-To: patched->closed 
State-Changed-By: dougb 
State-Changed-When: Wed Aug 10 00:18:41 UTC 2011 
State-Changed-Why:  

The change to include this information in the comments, 
as opposed to the body of the text has now been MFC'ed 
to RELENG_[87]. 


Responsible-Changed-From-To: gavin->dougb 
Responsible-Changed-By: dougb 
Responsible-Changed-When: Wed Aug 10 00:18:41 UTC 2011 
Responsible-Changed-Why:  

I did the change, so I own the pointy hats. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=154494 
>Unformatted:
