Bug 171941

Summary:

Return "Whom/Created by" to the porters handbook

Product:

Documentation

Reporter:

Adam Weinberger <adamw>

Component:

Books & Articles

Assignee:

Warren Block <wblock>

Status:

Closed FIXED

Severity:

Affects Only Me

CC:

portmgr

Priority:

Normal

Version:

Latest

Hardware:

Any

OS:

Any

Attachments:

Description	Flags
porters-handbook-header-revert.patch	none

Description Adam Weinberger freebsd_committer

2012-09-25 07:10:10 UTC

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.

Comment 1 Warren Block freebsd_committer

2012-09-25 13:42:04 UTC

Responsible Changed
From-To: freebsd-doc->wblock

Take.

Comment 2 dfilter service freebsd_committer

2012-09-26 16:36:52 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"

Comment 3 Warren Block freebsd_committer

2012-09-26 16:36:58 UTC

State Changed
From-To: open->closed

Slightly modified version of patch committed.  Thanks!