From adamw@adamw.org  Tue Sep 25 06:08:14 2012
Return-Path: <adamw@adamw.org>
Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52])
	by hub.freebsd.org (Postfix) with ESMTP id 565A41065670;
	Tue, 25 Sep 2012 06:08:14 +0000 (UTC)
	(envelope-from adamw@adamw.org)
Received: from apnoea.adamw.org (apnoea.adamw.org [204.109.59.150])
	by mx1.freebsd.org (Postfix) with ESMTP id 2E33D8FC0C;
	Tue, 25 Sep 2012 06:08:13 +0000 (UTC)
Received: by apnoea.adamw.org (Postfix, from userid 1002)
	id D418F45B37; Tue, 25 Sep 2012 02:08:06 -0400 (EDT)
Message-Id: <20120925060806.D418F45B37@apnoea.adamw.org>
Date: Tue, 25 Sep 2012 02:08:06 -0400 (EDT)
From: Adam Weinberger <adamw@FreeBSD.org>
Reply-To: Adam Weinberger <adamw@FreeBSD.org>
To: FreeBSD-gnats-submit@freebsd.org
Cc: portmgr@FreeBSD.org
Subject: Return "Whom/Created by" to the porters handbook
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         171941
>Category:       docs
>Synopsis:       Return "Whom/Created by" to the porters handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    wblock
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Sep 25 06:10:10 UTC 2012
>Closed-Date:    Wed Sep 26 15:37:27 UTC 2012
>Last-Modified:  Wed Sep 26 15:40:02 UTC 2012
>Originator:     Adam Weinberger
>Release:        FreeBSD 9.1-PRERELEASE i386
>Organization:
>Environment:
System: FreeBSD apnoea.adamw.org 9.1-PRERELEASE FreeBSD 9.1-PRERELEASE #0: Sun Sep 2 00:54:22 EDT 2012 root@apnoea.adamw.org:/usr/obj/usr/src/sys/PEEP i386


	
>Description:
The sample port Makefile headers and related instructions were stripped to
the single line version. The attached patch reflects portmgr's decision to
adopt the two-line header, while making it clear that the "Created by" line
is optional.

A single acknowledgement of the 2nd header line is restored back to the
example Makefile (with text I hope everyone can agree upon). Also
included is a correction to a warning to reflect that the "New [...]
makefile for:" and "Date" lines are being removed, not creator "name
and email" like the warning threatens.

>How-To-Repeat:
	
>Fix:

	

--- porters-handbook-header-revert.patch begins here ---
Index: book.sgml
===================================================================
--- book.sgml	(revision 39614)
+++ book.sgml	(working copy)
@@ -143,9 +143,9 @@
       <note>
 	<para>In some cases, the <filename>Makefile</filename> of an
 	  existing port may contain additional lines in the header,
-	  such as the name and email of the person that originally
-	  created the port.  This additional information has been
-	  declared obsolete, and is being phased out.</para>
+	  such as the name of the port and the date it was created.
+	  This additional information has been declared obsolete, and
+	  is being phased out.</para>
       </note>
 
       <para>See if you can figure it out.  Do not worry about the
@@ -16440,6 +16440,11 @@
 [ ^^^^^^^^^ This will be automatically replaced with RCS ID string by SVN
 when it is committed to our repository.  If upgrading a port, do not alter
 this line back to "&dollar;FreeBSD&dollar;".  SVN deals with it automatically.]
+# Created by:	Satoshi Asami &lt;asami@FreeBSD.org&gt;
+[This is the person who did the original port to FreeBSD, in particular, the
+person who wrote the first version of this Makefile.  Remember, this should
+not be changed when upgrading the port later.  This line is purely optional,
+and many contributors prefer not to include it.]
 
 [section to describe the port itself and the master site - PORTNAME
  and PORTVERSION are always first, followed by CATEGORIES,
--- porters-handbook-header-revert.patch ends here ---


>Release-Note:
>Audit-Trail:
Responsible-Changed-From-To: freebsd-doc->wblock 
Responsible-Changed-By: wblock 
Responsible-Changed-When: Tue Sep 25 12:42:04 UTC 2012 
Responsible-Changed-Why:  
Take. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=171941 
State-Changed-From-To: open->closed 
State-Changed-By: wblock 
State-Changed-When: Wed Sep 26 15:36:58 UTC 2012 
State-Changed-Why:  
Slightly modified version of patch committed.  Thanks! 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/171941: commit references a PR
Date: Wed, 26 Sep 2012 15:36:52 +0000 (UTC)

 Author: wblock
 Date: Wed Sep 26 15:36:37 2012
 New Revision: 39619
 URL: http://svn.freebsd.org/changeset/doc/39619
 
 Log:
   Return "Whom/Created by" to the porters handbook.  Make the rules about
   how to handle the Created by: line more clear.
   
   PR:		docs/171941
   Submitted by:	Adam Weinberger <adamw@FreeBSD.org>
 
 Modified:
   head/en_US.ISO8859-1/books/porters-handbook/book.sgml
 
 Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml
 ==============================================================================
 --- head/en_US.ISO8859-1/books/porters-handbook/book.sgml	Wed Sep 26 06:59:09 2012	(r39618)
 +++ head/en_US.ISO8859-1/books/porters-handbook/book.sgml	Wed Sep 26 15:36:37 2012	(r39619)
 @@ -143,9 +143,9 @@ USE_IMAKE=	yes
        <note>
  	<para>In some cases, the <filename>Makefile</filename> of an
  	  existing port may contain additional lines in the header,
 -	  such as the name and email of the person that originally
 -	  created the port.  This additional information has been
 -	  declared obsolete, and is being phased out.</para>
 +	  such as the name of the port and the date it was created.
 +	  This additional information has been declared obsolete, and
 +	  is being phased out.</para>
        </note>
  
        <para>See if you can figure it out.  Do not worry about the
 @@ -16440,6 +16440,10 @@ IGNORE=	POINTYHAT is not supported
  [ ^^^^^^^^^ This will be automatically replaced with RCS ID string by SVN
  when it is committed to our repository.  If upgrading a port, do not alter
  this line back to "&dollar;FreeBSD&dollar;".  SVN deals with it automatically.]
 +# Created by:	Satoshi Asami &lt;asami@FreeBSD.org&gt;
 +[The optional <emphasis>Created by:</emphasis> line names the person who originally
 +created the port.  If this line is present, future maintainers should
 +not change or remove it except at the original author's request.]
  
  [section to describe the port itself and the master site - PORTNAME
   and PORTVERSION are always first, followed by CATEGORIES,
 _______________________________________________
 svn-doc-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/svn-doc-all
 To unsubscribe, send any mail to "svn-doc-all-unsubscribe@freebsd.org"
 
>Unformatted:
