Date: Sun, 12 Jun 2011 08:40:32 GMT From: Chris Rees <crees@FreeBSD.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/157792: [PATCH] Porter's Handbook clarification on date strings as PORTVERSIONs Message-ID: <201106120840.p5C8eWnu099686@freefall.freebsd.org> Resent-Message-ID: <201106120850.p5C8o22J007368@freefall.freebsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 157792 >Category: docs >Synopsis: [PATCH] Porter's Handbook clarification on date strings as PORTVERSIONs >Confidential: no >Severity: non-critical >Priority: low >Responsible: freebsd-doc >State: open >Quarter: >Keywords: >Date-Required: >Class: doc-bug >Submitter-Id: current-users >Arrival-Date: Sun Jun 12 08:50:02 UTC 2011 >Closed-Date: >Last-Modified: >Originator: Chris Rees >Release: FreeBSD 8.2-STABLE i386 >Organization: >Environment: System: FreeBSD freefall.freebsd.org 8.2-STABLE FreeBSD 8.2-STABLE #4 r220774: Mon Apr 18 13:56:14 UTC 2011 simon@freefall.freebsd.org:/usr/obj/usr/src/sys/FREEFALL i386 >Description: The Porter's Handbook recommends using the date string (yyyy.mm.dd) as the version for a port if there's no version around, which unfortunately causes problems when version [e.g.] 3.4.1.3 is found. This would cause a PORTEPOCH bump, which no-one likes. I've changed to suggested version string to 0.0.yyyy.mm.dd with a short explanation. >How-To-Repeat: >Fix: --- doc-phandbook-yymmdd-patch.diff begins here --- Index: en_US.ISO8859-1/books/porters-handbook/book.sgml =================================================================== RCS file: /home/dcvs/doc/en_US.ISO8859-1/books/porters-handbook/book.sgml,v retrieving revision 1.1108 diff -u -r1.1108 book.sgml --- en_US.ISO8859-1/books/porters-handbook/book.sgml 3 Jun 2011 15:02:58 -0000 1.1108 +++ en_US.ISO8859-1/books/porters-handbook/book.sgml 12 Jun 2011 08:36:39 -0000 @@ -1210,12 +1210,15 @@ at the version string. In particular, make sure version number components are always delimited by a period, and if the date is part of the string, use the - <literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> + <literal>0.0.<replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> format, not <literal><replaceable>dd</replaceable>.<replaceable>mm</replaceable>.<replaceable>yyyy</replaceable></literal> or the non-Y2K compliant <literal><replaceable>yy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal> - format.</para> + format. It is important to prefix the version with + <literal>0.0.</literal> in case a release with an actual version + number is made, which would of course be numerically less than + <literal><replaceable>yyyy</replaceable></literal>.</para> </listitem> </orderedlist> @@ -1357,7 +1360,7 @@ release another version, just set the version string to <literal>1.0</literal> (like the <literal>piewm</literal> example above). Otherwise, ask the original author or use the date string - (<literal><replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>) + (<literal>0.0.<replaceable>yyyy</replaceable>.<replaceable>mm</replaceable>.<replaceable>dd</replaceable></literal>) as the version.</para> </sect2> </sect1> --- doc-phandbook-yymmdd-patch.diff ends here --- >Release-Note: >Audit-Trail: >Unformatted:
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201106120840.p5C8eWnu099686>