docs/171941: Return "Whom/Created by" to the porters handbook

Adam Weinberger adamw at FreeBSD.org
Tue Sep 25 06:10:11 UTC 2012


>Number:         171941
>Category:       docs
>Synopsis:       Return "Whom/Created by" to the porters handbook
>Confidential:   no
>Severity:       non-critical
>Priority:       medium
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Tue Sep 25 06:10:10 UTC 2012
>Closed-Date:
>Last-Modified:
>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 at 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 "$FreeBSD$".  SVN deals with it automatically.]
+# Created by:	Satoshi Asami <asami at FreeBSD.org>
+[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:
>Unformatted:



More information about the freebsd-doc mailing list