Bug 160369 - [patch] update sample simple makefile with new conventions
Summary: [patch] update sample simple makefile with new conventions
Status: Closed FIXED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Books & Articles (show other bugs)
Version: Latest
Hardware: Any Any
: Normal Affects Only Me
Assignee: Glen Barber
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-09-01 17:40 UTC by Eitan Adler
Modified: 2012-08-31 14:10 UTC (History)
0 users

See Also:


Attachments
file.diff (743 bytes, patch)
2011-09-01 17:40 UTC, Eitan Adler
no flags Details | Diff
porters-handbook-header.patch (1.64 KB, patch)
2012-08-31 11:45 UTC, Beat Gaetzi
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Eitan Adler freebsd_committer freebsd_triage 2011-09-01 17:40:07 UTC
I was told by sahil@ and bapt@ that we will now be ISO 8601:2004 form for new ports. 
Additionally, add a license to the sample makefile.
Comment 1 Eitan Adler freebsd_committer freebsd_triage 2011-09-01 17:46:09 UTC
Responsible Changed
From-To: freebsd-doc->gjb

You know you want it
Comment 2 Sahil Tandon freebsd_committer freebsd_triage 2011-09-01 21:20:45 UTC
On Thu, 2011-09-01 at 16:31:15 +0000, Eitan Adler wrote:

> >Description:
> I was told by sahil@ and bapt@ that we will now be ISO 8601:2004 form
> for new ports.  Additionally, add a license to the sample makefile.

I do not know if this is being officially adopted by the powers that be,
but it sure would be nice.  I recall this practice being passed down to
me by itetcu@ when he was my mentor.

> -# Date created:        5 December 1994
> +# Date created:        1994-12-5

Hmm, that's wrong; it should be 1994-12-05.

-- 
Sahil Tandon <sahil@FreeBSD.org>
Comment 3 Eitan Adler freebsd_committer freebsd_triage 2011-09-01 23:01:25 UTC
>> -# Date created: =C2=A0 =C2=A0 =C2=A0 =C2=A05 December 1994
>> +# Date created: =C2=A0 =C2=A0 =C2=A0 =C2=A01994-12-5
>
> Hmm, that's wrong; it should be 1994-12-05.

Darnit. I thought I typed that.
Here is the corrected patch

Index: book.sgml
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=
=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D=3D
RCS file: /home/ncvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v
retrieving revision 1.1115
diff -u -r1.1115 book.sgml
--- book.sgml	15 Aug 2011 06:06:40 -0000	1.1115
+++ book.sgml	1 Sep 2011 22:00:25 -0000
@@ -120,7 +120,7 @@
 	  like this:</para>

 	<programlisting># New ports collection makefile for:   oneko
-# Date created:        5 December 1994
+# Date created:        1994-12-05
 # Whom:                asami
 #
 # &dollar;FreeBSD&dollar;
@@ -134,6 +134,8 @@
 MAINTAINER=3D    asami@FreeBSD.org
 COMMENT=3D       A cat chasing a mouse all over the screen

+LICENSE=3D       MIT
+
 MAN1=3D          oneko.1
 MANCOMPRESSED=3D yes
 USE_IMAKE=3D     yes


>
> --
> Sahil Tandon <sahil@FreeBSD.org>
>



--=20
Eitan Adler
Ports committer
Bugbusting team
Comment 4 Glen Barber freebsd_committer freebsd_triage 2011-09-02 01:36:02 UTC
On 9/1/11 4:30 PM, Sahil Tandon wrote:
>  > >Description:
>  > I was told by sahil@ and bapt@ that we will now be ISO 8601:2004 form
>  > for new ports.  Additionally, add a license to the sample makefile.
>  
>  I do not know if this is being officially adopted by the powers that be,
>  but it sure would be nice.  I recall this practice being passed down to
>  me by itetcu@ when he was my mentor.
>  

Hi Sahil,

By "powers that be", do you mean portmgr?  If so, I'll ping them before
making this change to confirm this is the wanted format.

Thanks,

Glen

-- 
Glen Barber | gjb@FreeBSD.org
FreeBSD Documentation Project
Comment 5 Sahil Tandon freebsd_committer freebsd_triage 2011-09-02 02:51:18 UTC
Glen Barber wrote:
> On 9/1/11 4:30 PM, Sahil Tandon wrote:
>>   >  >Description:
>>   >  I was told by sahil@ and bapt@ that we will now be ISO 8601:2004 form
>>   >  for new ports.  Additionally, add a license to the sample makefile.
>>
>>   I do not know if this is being officially adopted by the powers that be,
>>   but it sure would be nice.  I recall this practice being passed down to
>>   me by itetcu@ when he was my mentor.
>>
>
> Hi Sahil,
>
> By "powers that be", do you mean portmgr?  If so, I'll ping them before
> making this change to confirm this is the wanted format.

Yes, I am referring to portmgr.  Because itetcu@ was on portmgr, I know 
*some* of them will be receptive to making this change more prominent 
throughout the documentation, so it makes sense to ping them before 
committing this change.

-- 
Sahil Tandon <sahil@FreeBSD.org>
Comment 6 Glen Barber freebsd_committer freebsd_triage 2011-09-03 00:47:56 UTC
State Changed
From-To: open->suspended

Feedback from portmgr suggests a different solution - excluding 
the non-rcsid comment lines moving forward. 

Suspend this PR for now until the relevant sanity-checking tools 
have been updated accordingly, after which, the Porter's Handbook 
should be updated to note these lines are not necessary.
Comment 7 Eitan Adler freebsd_committer freebsd_triage 2011-09-03 01:02:11 UTC
This is what I prefer. Original patch came from feedback from sahil@ and bapt@.
I'm glad portmgr went this route.

On Fri, Sep 2, 2011 at 7:51 PM,  <gjb@freebsd.org> wrote:
> Synopsis: [patch] update sample simple makefile with new conventions
>
> State-Changed-From-To: open->suspended
> State-Changed-By: gjb
> State-Changed-When: Fri Sep 2 23:47:56 UTC 2011
> State-Changed-Why:
> Feedback from portmgr suggests a different solution - excluding
> the non-rcsid comment lines moving forward.
>
> Suspend this PR for now until the relevant sanity-checking tools
> have been updated accordingly, after which, the Porter's Handbook
> should be updated to note these lines are not necessary.
>
>
> http://www.freebsd.org/cgi/query-pr.cgi?pr=160369
>



-- 
Eitan Adler
Ports committer
Bugbusting team
Comment 8 Beat Gaetzi freebsd_committer freebsd_triage 2012-08-31 11:45:55 UTC
Hi,

Attached a new patch which updates the header to the new format.

Beat
Comment 9 dfilter service freebsd_committer freebsd_triage 2012-08-31 14:00:55 UTC
Author: gjb
Date: Fri Aug 31 13:00:39 2012
New Revision: 39479
URL: http://svn.freebsd.org/changeset/doc/39479

Log:
  Remove the port creation meta-lines from the Porters Handbook.
  
  PR:		160369
  Submitted by:	eadler (original)
  Patched by:	portmgr (beat)

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	Fri Aug 31 12:19:04 2012	(r39478)
+++ head/en_US.ISO8859-1/books/porters-handbook/book.sgml	Fri Aug 31 13:00:39 2012	(r39479)
@@ -120,12 +120,7 @@
       <para>The minimal <filename>Makefile</filename> would look
 	something like this:</para>
 
-      <programlisting># New ports collection makefile for:	oneko
-# Date created:        5 December 1994
-# Whom:                asami
-#
-# &dollar;FreeBSD&dollar;
-#
+      <programlisting># &dollar;FreeBSD&dollar;
 
 PORTNAME=	oneko
 PORTVERSION=	1.1b
@@ -16289,20 +16284,10 @@ IGNORE=	POINTYHAT is not supported
       <filename>Makefile</filename>.</para>
 
     <programlisting>[the header...just to make it easier for us to identify the ports.]
-# New ports collection makefile for:   xdvi
-[the "version required" line is only needed when the PORTVERSION
- variable is not specific enough to describe the port.]
-# Date created:                26 May 1995
-[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.]
-# Whom:                        Satoshi Asami &lt;asami@FreeBSD.org&gt;
-#
 # &dollar;FreeBSD&dollar;
 [ ^^^^^^^^^ 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.]
-#
 
 [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 10 Glen Barber freebsd_committer freebsd_triage 2012-08-31 14:01:24 UTC
State Changed
From-To: suspended->closed

Committed, thanks!