svn commit: r50629 - head/en_US.ISO8859-1/books/porters-handbook/makefiles

[Mathieu Arnold]

Author: mat
Date: Fri Aug  4 10:24:00 2017
New Revision: 50629
URL: https://svnweb.freebsd.org/changeset/doc/50629

Log:
  Fix the "Package Naming Examples" table.  It was badly outdated.
  
  Sponsored by:	Absolight, The FreeBSD Foundation

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Fri Aug  4 10:23:58 2017	(r50628)
+++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Fri Aug  4 10:24:00 2017	(r50629)
@@ -740,8 +740,11 @@ PORTEPOCH=	1</programlisting>
       </important>
 
       <para>Here are some (real) examples on how to convert the name
-	as called by the software authors to a suitable package
-	name:</para>
+	as called by the software authors to a suitable package name,
+	for each line, only one of <varname>DISTVERSION</varname> or
+	<varname>PORTVERSION</varname> is set in, depending on which
+	would be used in the port's
+	<filename>Makefile</filename>:</para>
 
       <table frame="none" pgwide="1">
 	<title>Package Naming Examples</title>
@@ -753,8 +756,9 @@ PORTEPOCH=	1</programlisting>
 	      <entry><varname>PKGNAMEPREFIX</varname></entry>
 	      <entry><varname>PORTNAME</varname></entry>
 	      <entry><varname>PKGNAMESUFFIX</varname></entry>
+	      <entry><varname>DISTVERSION</varname></entry>
 	      <entry><varname>PORTVERSION</varname></entry>
-	      <entry>Reason</entry>
+	      <entry>Reason or comment</entry>
 	    </row>
 	  </thead>
 
@@ -765,6 +769,7 @@ PORTEPOCH=	1</programlisting>
 	      <entry>mule</entry>
 	      <entry>(empty)</entry>
 	      <entry>2.2.2</entry>
+	      <entry></entry>
 	      <entry>No changes required</entry>
 	    </row>
 
@@ -774,7 +779,10 @@ PORTEPOCH=	1</programlisting>
 	      <entry>mule</entry>
 	      <entry>1</entry>
 	      <entry>1.0.1</entry>
-	      <entry><literal>mule</literal> already exists</entry>
+	      <entry></entry>
+	      <entry>This is version 1 of
+		<application>mule</application>, and version 2 already
+		exists</entry>
 	    </row>
 
 	    <row>
@@ -783,6 +791,7 @@ PORTEPOCH=	1</programlisting>
 	      <entry>emiclock</entry>
 	      <entry>(empty)</entry>
 	      <entry>1.0.2</entry>
+	      <entry></entry>
 	      <entry>No uppercase names for single programs</entry>
 	    </row>
 
@@ -791,9 +800,9 @@ PORTEPOCH=	1</programlisting>
 	      <entry>(empty)</entry>
 	      <entry>rdist</entry>
 	      <entry>(empty)</entry>
-	      <entry>1.3.a</entry>
-	      <entry>No strings like <literal>alpha</literal>
-		allowed</entry>
+	      <entry>1.3alpha</entry>
+	      <entry></entry>
+	      <entry>Version will be <literal>1.3.a</literal></entry>
 	    </row>
 
 	    <row>
@@ -801,9 +810,9 @@ PORTEPOCH=	1</programlisting>
 	      <entry>(empty)</entry>
 	      <entry>es</entry>
 	      <entry>(empty)</entry>
-	      <entry>0.9.b1</entry>
-	      <entry>No strings like <literal>beta</literal>
-		allowed</entry>
+	      <entry>0.9-beta1</entry>
+	      <entry></entry>
+	      <entry>Version will be <literal>0.9.b1</literal></entry>
 	    </row>
 
 	    <row>
@@ -811,9 +820,9 @@ PORTEPOCH=	1</programlisting>
 	      <entry>(empty)</entry>
 	      <entry>mailman</entry>
 	      <entry>(empty)</entry>
-	      <entry>2.0.r3</entry>
-	      <entry>No strings like <literal>rc</literal>
-		allowed</entry>
+	      <entry>2.0rc3</entry>
+	      <entry></entry>
+	      <entry>Version will be <varname>2.0.r3</varname></entry>
 	    </row>
 
 	    <row>
@@ -821,6 +830,7 @@ PORTEPOCH=	1</programlisting>
 	      <entry>(empty)</entry>
 	      <entry>tiff</entry>
 	      <entry>(empty)</entry>
+	      <entry></entry>
 	      <entry>3.3</entry>
 	      <entry>What the heck was that anyway?</entry>
 	    </row>
@@ -830,8 +840,10 @@ PORTEPOCH=	1</programlisting>
 	      <entry>(empty)</entry>
 	      <entry>tvtwm</entry>
 	      <entry>(empty)</entry>
-	      <entry>pl11</entry>
-	      <entry>Version string always required</entry>
+	      <entry></entry>
+	      <entry>p11</entry>
+	      <entry>No version in the filename, use what upstream
+		says it is</entry>
 	    </row>
 
 	    <row>
@@ -840,7 +852,9 @@ PORTEPOCH=	1</programlisting>
 	      <entry>piewm</entry>
 	      <entry>(empty)</entry>
 	      <entry>1.0</entry>
-	      <entry>Version string always required</entry>
+	      <entry></entry>
+	      <entry>No version in the filename, use what upstream
+		says it is</entry>
 	    </row>
 
 	    <row>
@@ -848,9 +862,10 @@ PORTEPOCH=	1</programlisting>
 	      <entry>(empty)</entry>
 	      <entry>xvgr</entry>
 	      <entry>(empty)</entry>
-	      <entry>2.10.1</entry>
-	      <entry><literal>pl</literal> allowed only when no
-		major/minor version numbers</entry>
+	      <entry></entry>
+	      <entry>2.10.pl1</entry>
+	      <entry>In that case, <literal>pl1</literal> means patch
+		level, so using DISTVERSION is not possible.</entry>
 	    </row>
 
 	    <row>
@@ -859,6 +874,7 @@ PORTEPOCH=	1</programlisting>
 	      <entry>gawk</entry>
 	      <entry>(empty)</entry>
 	      <entry>2.15.6</entry>
+	      <entry></entry>
 	      <entry>Japanese language version</entry>
 	    </row>
 
@@ -868,6 +884,7 @@ PORTEPOCH=	1</programlisting>
 	      <entry>psutils</entry>
 	      <entry>-letter</entry>
 	      <entry>1.13</entry>
+	      <entry></entry>
 	      <entry>Paper size hardcoded at package build
 		time</entry>
 	    </row>
@@ -878,6 +895,7 @@ PORTEPOCH=	1</programlisting>
 	      <entry>pkfonts</entry>
 	      <entry>300</entry>
 	      <entry>1.0</entry>
+	      <entry></entry>
 	      <entry>Package for 300dpi fonts</entry>
 	    </row>
 	  </tbody>