Date: Fri, 4 Aug 2017 10:24:04 +0000 (UTC) From: Mathieu Arnold <mat@FreeBSD.org> To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r50630 - in head/en_US.ISO8859-1/books/porters-handbook: makefiles plist porting-samplem quick-porting security special Message-ID: <201708041024.v74AO4VV068837@repo.freebsd.org>
next in thread | raw e-mail | index | archive | help
Author: mat Date: Fri Aug 4 10:24:03 2017 New Revision: 50630 URL: https://svnweb.freebsd.org/changeset/doc/50630 Log: Replace usage of PORTVERSION with DISTVERSION. Sponsored by: Absolight, The FreeBSD Foundation Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/security/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/special/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:24:00 2017 (r50629) +++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Aug 4 10:24:03 2017 (r50630) @@ -329,7 +329,7 @@ PORTVERSION= 1.2p4</programlisting> <para><varname>PORTREVISION</varname> is a monotonically increasing value which is reset to 0 with - every increase of <varname>PORTVERSION</varname>, typically + every increase of <varname>DISTVERSION</varname>, typically every time there is a new official vendor release. If <varname>PORTREVISION</varname> is non-zero, the value is appended to the package name. Changes to @@ -379,7 +379,7 @@ PORTVERSION= 1.2p4</programlisting> significant functional differences. For example, changes to the distfile requiring a correction to <filename>distinfo</filename> with no corresponding - change to <varname>PORTVERSION</varname>, where a + change to <varname>DISTVERSION</varname>, where a <command>diff -ru</command> of the old and new versions shows non-trivial changes to the code.</para> </listitem> @@ -487,7 +487,9 @@ PORTVERSION= 1.2p4</programlisting> <para>It is expected that <varname>PORTEPOCH</varname> will not be used for the majority of ports, and that sensible use - of <varname>PORTVERSION</varname> can often preempt it + of <varname>DISTVERSION</varname>, or that use + <varname>PORTVERSION</varname> carefully, can often preempt + it becoming necessary if a future release of the software changes the version structure. However, care is needed by &os; porters when a vendor release is made without @@ -501,8 +503,8 @@ PORTVERSION= 1.2p4</programlisting> <literal>20000917</literal>, and the previous version of the software was version <literal>1.2</literal>, do not use <literal>20000917</literal> for - <varname>PORTVERSION</varname>. The correct way is a - <varname>PORTVERSION</varname> of + <varname>DISTVERSION</varname>. The correct way is a + <varname>DISTVERSION</varname> of <literal>1.2.20000917</literal>, or similar, so that the succeeding release, say <literal>1.3</literal>, is still a numerically greater value.</para> @@ -517,7 +519,7 @@ PORTVERSION= 1.2p4</programlisting> collection:</para> <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.10</programlisting> +DISTVERSION= 0.10</programlisting> <para><varname>PKGNAME</varname> becomes <literal>gtkmumble-0.10</literal>.</para> @@ -527,7 +529,7 @@ PORTVERSION= 0.10</programlisting> accordingly.</para> <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.10 +DISTVERSION= 0.10 PORTREVISION= 1</programlisting> <para><varname>PKGNAME</varname> becomes @@ -547,7 +549,7 @@ PORTREVISION= 1</programlisting> removed from the <filename>Makefile</filename>).</para> <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.2 +DISTVERSION= 0.2 PORTEPOCH= 1</programlisting> <para><varname>PKGNAME</varname> becomes @@ -558,7 +560,7 @@ PORTEPOCH= 1</programlisting> variables are now:</para> <programlisting>PORTNAME= gtkmumble -PORTVERSION= 0.3 +DISTVERSION= 0.3 PORTEPOCH= 1</programlisting> <para><varname>PKGNAME</varname> becomes @@ -649,7 +651,7 @@ PORTEPOCH= 1</programlisting> <para>Make sure that the port's name and version are clearly separated and placed into <varname>PORTNAME</varname> and - <varname>PORTVERSION</varname>. The only + <varname>DISTVERSION</varname>. The only reason for <varname>PORTNAME</varname> to contain a version part is if the upstream distribution is really named that way, as in the @@ -1807,7 +1809,7 @@ PORTEPOCH= 1</programlisting> called by the authors of the software. <varname>DISTNAME</varname> defaults to <literal>${PORTNAME}-${DISTVERSIONPREFIX}${DISTVERSION}${DISTVERSIONSUFFIX}</literal>, - and <varname>DISTVERSION</varname> defaults to + and if not set, <varname>DISTVERSION</varname> defaults to <literal>${PORTVERSION}</literal> so override <varname>DISTNAME</varname> only if necessary. <varname>DISTNAME</varname> is only used @@ -2419,7 +2421,7 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${POR this (slightly stripped for the example):</para> <programlisting>PORTNAME= pkg -PORTVERSION= 1.2.7 +DISTVERSION= 1.2.7 USE_GITHUB= yes GH_ACCOUNT= freebsd</programlisting> @@ -2442,7 +2444,7 @@ GH_ACCOUNT= freebsd</programlisting> this (slightly stripped for the example):</para> <programlisting>PORTNAME= pkg-devel -PORTVERSION= 1.3.0.a.20140411 +DISTVERSION= 1.3.0.a.20140411 USE_GITHUB= yes GH_ACCOUNT= freebsd @@ -2467,8 +2469,8 @@ GH_TAGNAME= 6dbb17b</programlisting> <varname>DISTVERSIONSUFFIX</varname>:</para> <programlisting>PORTNAME= foo -PORTVERSION= 1.0.2 DISTVERSIONPREFIX= v +DISTVERSION= 1.0.2 USE_GITHUB= yes</programlisting> @@ -2548,7 +2550,7 @@ USE_GITHUB= yes</programlisting> variables:</para> <programlisting>PORTNAME= foo -PORTVERSION= 1.0.2 +DISTVERSION= 1.0.2 USE_GITHUB= yes GH_ACCOUNT= bar:icons,contrib @@ -2608,7 +2610,7 @@ CONFIGURE_ARGS= --with-contrib=${WRKSRC_contrib}</prog using <varname>GH_TUPLE</varname>:</para> <programlisting>PORTNAME= foo -PORTVERSION= 1.0.2 +DISTVERSION= 1.0.2 USE_GITHUB= yes GH_TUPLE= bar:foo-icons:1.0:icons/ext/icons \ @@ -2713,8 +2715,8 @@ Submodule path 'lib/wxsqlite3': checked out 'fb66eb230 (only GitHub-related lines are shown):</para> <programlisting>PORTNAME= moneymanagerex -PORTVERSION= 1.3.0 DISTVERSIONPREFIX= v +DISTVERSION= 1.3.0 USE_GITHUB= yes GH_TUPLE= utelle:wxsqlite3:v3.4.0:wxsqlite3/lib/wxsqlite3 \ @@ -5466,7 +5468,7 @@ BAR_LIB_DEPENDS= libbar.so:foo/bar</programlisting> of <filename>japanese/xdvi300/Makefile</filename>;</para> <programlisting>PORTNAME= xdvi -PORTVERSION= 17 +DISTVERSION= 17 PKGNAMEPREFIX= ja- PKGNAMESUFFIX= ${RESOLUTION} @@ -6915,7 +6917,7 @@ post-patch: <filename>Makefile</filename> has:</para> <programlisting>PORTNAME= foo -PORTVERSION= 1.0</programlisting> +DISTVERSION= 1.0</programlisting> <para>then the port's distribution files contain a top-level directory, <filename>foo-1.0</filename>, and the rest of the Modified: head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Fri Aug 4 10:24:00 2017 (r50629) +++ head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Fri Aug 4 10:24:03 2017 (r50630) @@ -318,7 +318,7 @@ PLIST_SUB+= X11I386="@comment " <filename>Makefile</filename>:</para> <programlisting>PORTNAME= Machine-Build -PORTVERSION= 1 +DISTVERSION= 1 CATEGORIES= devel perl5 MASTER_SITES= CPAN PKGNAMEPREFIX= p5- Modified: head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml Fri Aug 4 10:24:00 2017 (r50629) +++ head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml Fri Aug 4 10:24:03 2017 (r50630) @@ -29,13 +29,13 @@ when it is committed to our repository. If upgrading this line back to "$FreeBSD$". SVN deals with it automatically.] [section to describe the port itself and the master site - PORTNAME - and PORTVERSION are always first, followed by CATEGORIES, - and then MASTER_SITES, which can be followed by MASTER_SITE_SUBDIR. - PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, will be after that. - Then comes DISTNAME, EXTRACT_SUFX and/or DISTFILES, and then - EXTRACT_ONLY, as necessary.] + and PORTVERSION or the DISTVERSION* variables are always first, + followed by CATEGORIES, and then MASTER_SITES, which can be followed + by MASTER_SITE_SUBDIR. PKGNAMEPREFIX and PKGNAMESUFFIX, if needed, + will be after that. Then comes DISTNAME, EXTRACT_SUFX and/or + DISTFILES, and then EXTRACT_ONLY, as necessary.] PORTNAME= xdvi -PORTVERSION= 18.2 +DISTVERSION= 18.2 CATEGORIES= print [do not forget the trailing slash ("/")! if not using MASTER_SITE_* macros] Modified: head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Fri Aug 4 10:24:00 2017 (r50629) +++ head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Fri Aug 4 10:24:03 2017 (r50630) @@ -48,7 +48,7 @@ <programlisting># $FreeBSD$ PORTNAME= oneko -PORTVERSION= 1.1b +DISTVERSION= 1.1b CATEGORIES= games MASTER_SITES= ftp://ftp.cs.columbia.edu/archives/X11R5/contrib/ Modified: head/en_US.ISO8859-1/books/porters-handbook/security/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/security/chapter.xml Fri Aug 4 10:24:00 2017 (r50629) +++ head/en_US.ISO8859-1/books/porters-handbook/security/chapter.xml Fri Aug 4 10:24:03 2017 (r50630) @@ -76,12 +76,12 @@ to run an update. Besides, a new package will be built and distributed over FTP and WWW mirrors, replacing the vulnerable one. Bump <varname>PORTREVISION</varname> unless - <varname>PORTVERSION</varname> has changed in the course of + <varname>DISTVERSION</varname> has changed in the course of correcting the vulnerability. That is, bump <varname>PORTREVISION</varname> if adding a patch file to the port, but do not bump it if updating the port to the latest software version and thus already touched - <varname>PORTVERSION</varname>. Please refer to the + <varname>DISTVERSION</varname>. Please refer to the <link linkend="makefile-naming-revepoch">corresponding section</link> for more information.</para> </sect1> Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Fri Aug 4 10:24:00 2017 (r50629) +++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Fri Aug 4 10:24:03 2017 (r50630) @@ -1498,7 +1498,7 @@ USE_XORG= x11 xpm</programlisting> <programlisting># $FreeBSD$ PORTNAME= regexxer -PORTVERSION= 0.10 +DISTVERSION= 0.10 CATEGORIES= devel textproc gnome MASTER_SITES= GNOME @@ -3563,7 +3563,7 @@ do-install: <title>Example Makefile for PEAR Class</title> <programlisting>PORTNAME= Date -PORTVERSION= 1.4.3 +DISTVERSION= 1.4.3 CATEGORIES= devel www pear MAINTAINER= example@domain.com @@ -3598,7 +3598,7 @@ USES= pear Module</title> <programlisting>PORTNAME= Horde_Core -PORTVERSION= 2.14.0 +DISTVERSION= 2.14.0 CATEGORIES= devel www pear MAINTAINER= horde@FreeBSD.org @@ -3751,7 +3751,7 @@ SOCKETS_USE= PHP=sockets Module</title> <programlisting>PORTNAME= sample -PORTVERSION= 1.2.3 +DISTVERSION= 1.2.3 CATEGORIES= devel MAINTAINER= john@doe.tld
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?201708041024.v74AO4VV068837>