svn commit: r50564 - head/en_US.ISO8859-1/books/porters-handbook/porting-samplem

Richard Gallamore ultima at FreeBSD.org
Tue Jul 25 19:55:21 UTC 2017


Author: ultima (ports committer)
Date: Tue Jul 25 19:55:20 2017
New Revision: 50564
URL: https://svnweb.freebsd.org/changeset/doc/50564

Log:
  * Sort sample Makefile to comply with the chapter
  * Added USE_x examples
  * Added option section with examples
  * Created new section block, Standard bsd.port.mk Variables
  
  The new section block has always existed, but as a "ghost" section. It is widely
  accepted and known, mostly used in the USES section which is quite restrictive.
  This added section block will help clear up possible confusion between the USES
  section block jumping to the option section and grant the ghost a home.
  
  Reviewed by:	mat, matthew (mentor), wblock
  Approved by:	mat, matthew (mentor)
  Differential Revision:	https://reviews.freebsd.org/D11523

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

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	Tue Jul 25 17:50:09 2017	(r50563)
+++ head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml	Tue Jul 25 19:55:20 2017	(r50564)
@@ -49,11 +49,14 @@ EXTRACT_SUFX=	.tar.Z
 [section for distributed patches -- can be empty]
 PATCH_SITES=	ftp://ftp.sra.co.jp/pub/X11/japanese/
 PATCHFILES=	xdvi-18.patch1.gz xdvi-18.patch2.gz
+[If the distributed patches were not made relative to ${WRKSRC},
+ this may need to be tweaked]
+PATCH_DIST_STRIP=	-p1
 
 [maintainer; *mandatory*!  This is the person who is volunteering to
  handle port updates, build breakages, and to whom a users can direct
  questions and bug reports.  To keep the quality of the Ports Collection
- as high as possible, we no longer accept new ports that are assigned to
+ as high as possible, we do not accept new ports that are assigned to
  "ports at FreeBSD.org".]
 MAINTAINER=	asami at FreeBSD.org
 COMMENT=	DVI Previewer for the X Window System
@@ -65,23 +68,34 @@ LICENSE_FILE=	${WRKSRC}/LICENSE
 [dependencies -- can be empty]
 RUN_DEPENDS=	gs:print/ghostscript
 
-[this section is for other standard bsd.port.mk variables that do not
+[If it requires GNU make, not /usr/bin/make, to build...]
+USES= gmake
+[If it is an X application and requires "xmkmf -a" to be run...]
+USES= imake
+[If the source is obtained from github, remove MASTER_SITE* and...]
+USE_GITHUB=	yes
+GH_ACCOUNT=	example
+
+[this section is for other standard bsd.port.mk variables that do not]
  belong to any of the above]
 [If it asks questions during configure, build, install...]
 IS_INTERACTIVE=	yes
 [If it extracts to a directory other than ${DISTNAME}...]
 WRKSRC=		${WRKDIR}/xdvi-new
-[If the distributed patches were not made relative to ${WRKSRC},
- this may need to be tweaked]
-PATCH_DIST_STRIP=	-p1
 [If it requires a "configure" script generated by GNU autoconf to be run]
 GNU_CONFIGURE=	yes
-[If it requires GNU make, not /usr/bin/make, to build...]
-USES= gmake
-[If it is an X application and requires "xmkmf -a" to be run...]
-USES= imake
 [et cetera.]
 
+[If it requires options, this section is for options]
+OPTIONS_DEFINE=	DOCS EXAMPLES FOO
+OPTIONS_DEFAULT=	FOO
+[If options will change the files in plist]
+OPTIONS_SUB=yes
+
+FOO_DESC=		Enable foo support
+
+FOO_CONFIGURE_ENABLE=	foo
+
 [non-standard variables to be used in the rules below]
 MY_FAVORITE_RESPONSE=	"yeah, right"
 
@@ -472,6 +486,20 @@ pre-install:
 	always put the
 	<varname>GH_<replaceable>*</replaceable></varname> variables
 	right after it.</para>
+    </sect2>
+
+    <sect2 xml:id="porting-samplem-variables">
+      <title>Standard <filename>bsd.port.mk</filename> Variables</title>
+
+      <para>This section block is for variables that can be defined in
+        <filename>bsd.port.mk</filename> that do not belong in any
+        of the previous section blocks.</para>
+
+      <para>Order is not important, however try to keep similar variables together.
+        For example uid and gid variables <varname>USERS</varname> and <varname>GROUPS</varname>.
+	Configuration variables <varname>CONFIGURE_<replaceable>*</replaceable></varname> and
+        <varname><replaceable>*</replaceable>_CONFIGURE</varname>. List of files, and directories
+        <varname>PORTDOCS</varname> and <varname>PORTEXAMPLES</varname>.</para>
     </sect2>
 
     <sect2 xml:id="porting-samplem-options">


More information about the svn-doc-all mailing list