From owner-svn-doc-all@FreeBSD.ORG Fri Mar 21 13:26:42 2014 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:1900:2254:206a::19:1]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id C2ED946C; Fri, 21 Mar 2014 13:26:42 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id ADBEE9AF; Fri, 21 Mar 2014 13:26:42 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.8/8.14.8) with ESMTP id s2LDQg5p020335; Fri, 21 Mar 2014 13:26:42 GMT (envelope-from mat@svn.freebsd.org) Received: (from mat@localhost) by svn.freebsd.org (8.14.8/8.14.8/Submit) id s2LDQfml020329; Fri, 21 Mar 2014 13:26:41 GMT (envelope-from mat@svn.freebsd.org) Message-Id: <201403211326.s2LDQfml020329@svn.freebsd.org> From: Mathieu Arnold Date: Fri, 21 Mar 2014 13:26:41 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r44305 - in head/en_US.ISO8859-1/books/porters-handbook: makefiles quick-porting slow-porting special X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.17 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 21 Mar 2014 13:26:42 -0000 Author: mat (ports committer) Date: Fri Mar 21 13:26:41 2014 New Revision: 44305 URL: http://svnweb.freebsd.org/changeset/doc/44305 Log: Add xml:id to sect[123]. Sponsored by: Absolight Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/slow-porting/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 Thu Mar 20 19:37:47 2014 (r44304) +++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Fri Mar 21 13:26:41 2014 (r44305) @@ -49,7 +49,7 @@ names the port, describes its version number, and lists it in the correct category. - + <varname>PORTNAME</varname> and <varname>PORTVERSION</varname> @@ -70,7 +70,7 @@ <varname>PORTREVISION</varname> and <varname>PORTEPOCH</varname> - + <varname>PORTREVISION</varname> The PORTREVISION variable is a @@ -176,7 +176,7 @@ PORTREVISION should be bumped. - + <varname>PORTEPOCH</varname> From time to time a software vendor or &os; porter will @@ -241,7 +241,7 @@ still a numerically greater value. - + Example of <varname>PORTREVISION</varname> and <varname>PORTEPOCH</varname> Usage @@ -602,7 +602,7 @@ PORTEPOCH= 1 Categorization - + <varname>CATEGORIES</varname> When a package is created, it is put under @@ -1480,7 +1480,7 @@ PORTEPOCH= 1 describes the files that must be downloaded in order to build the port, and where they can be downloaded from. - + <varname>DISTVERSION/DISTNAME</varname> DISTNAME is the name of the port as @@ -1570,7 +1570,7 @@ PORTEPOCH= 1 - + <varname>MASTER_SITES</varname> Record the directory part of the FTP/HTTP-URL pointing at @@ -1734,7 +1734,7 @@ MASTER_SITE_SUBDIR= stardict/WyabdcRealP - + <varname>EXTRACT_SUFX</varname> If you have one distribution file, and it uses an odd @@ -1764,7 +1764,7 @@ EXTRACT_SUFX= .tar.gzip - + <varname>DISTFILES</varname> Sometimes the names of the files to be downloaded have no @@ -1784,7 +1784,7 @@ EXTRACT_SUFX= .tar.gzip ${DISTNAME}${EXTRACT_SUFX}. - + <varname>EXTRACT_ONLY</varname> If only some of the DISTFILES must be @@ -1903,7 +1903,7 @@ EXTRACT_ONLY= source.tar.gz - + Simplified Information This section tells you how to quickly prepare fine @@ -1972,7 +1972,7 @@ DISTFILES= source1.tar.gz:source1 \ - + Detailed Information Okay, so the previous section example did not reflect @@ -2373,7 +2373,7 @@ PATCHFILES= patch1:test - + What Does Change for Ports? What Does Not? @@ -2494,7 +2494,7 @@ PATCHFILES= patch1:test - + <varname>DIST_SUBDIR</varname> Do not let your port clutter @@ -2525,7 +2525,7 @@ PATCHFILES= patch1:test - + <varname>ALWAYS_KEEP_DISTFILES</varname> If your port uses binary distfiles and has a license that @@ -2716,7 +2716,7 @@ ALWAYS_KEEP_DISTFILES= yes also some pre-supported dependency variables for common cases, plus a few more to control the behavior of dependencies. - + <varname>LIB_DEPENDS</varname> This variable specifies the shared libraries this port @@ -2743,7 +2743,7 @@ ALWAYS_KEEP_DISTFILES= yes system. - + <varname>RUN_DEPENDS</varname> This variable specifies executables or files this port @@ -2824,7 +2824,7 @@ ALWAYS_KEEP_DISTFILES= yes RUN_DEPENDS:= ${BUILD_DEPENDS} - + <varname>BUILD_DEPENDS</varname> This variable specifies executables or files this port @@ -2849,7 +2849,7 @@ ALWAYS_KEEP_DISTFILES= yes - + <varname>FETCH_DEPENDS</varname> This variable specifies executables or files this port @@ -2870,7 +2870,7 @@ ALWAYS_KEEP_DISTFILES= yes the same as DEPENDS_TARGET. - + <varname>EXTRACT_DEPENDS</varname> This variable specifies executables or files this port @@ -2900,7 +2900,7 @@ ALWAYS_KEEP_DISTFILES= yes - + <varname>PATCH_DEPENDS</varname> This variable specifies executables or files this port @@ -3029,7 +3029,7 @@ ALWAYS_KEEP_DISTFILES= yes Xfce. - + Minimal Version of a Dependency A minimal version of a dependency can be specified in any @@ -3045,7 +3045,7 @@ ALWAYS_KEEP_DISTFILES= yes p5-Spiffy-0.26 or newer is installed on the machine. - + Notes on Dependencies As mentioned above, the default target to call when a @@ -3080,7 +3080,7 @@ ALWAYS_KEEP_DISTFILES= yes and extract it. - + Circular Dependencies Are Fatal @@ -3100,7 +3100,7 @@ ALWAYS_KEEP_DISTFILES= yes a lot of grief in the process. - + Problems Caused by Automatic Dependencies Dependencies must be declared either explicitly or by @@ -3293,10 +3293,10 @@ MASTERDIR= ${.CURDIR}/../xdvi300 options properly will make users happy, and effectively provide two or more ports for the price of one. - + Knobs - + <varname>WITH_<replaceable>*</replaceable></varname> and <varname>WITHOUT_<replaceable>*</replaceable></varname> @@ -3360,7 +3360,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300 - + Knob Naming Porters should use like-named knobs, both for the @@ -3382,10 +3382,10 @@ MASTERDIR= ${.CURDIR}/../xdvi300 - + <varname>OPTIONS</varname> - + Background The OPTIONS_* variables give the @@ -3415,7 +3415,7 @@ MASTERDIR= ${.CURDIR}/../xdvi300 to remove the saved configuration. - + Syntax OPTIONS_DEFINE contains a list of @@ -3574,7 +3574,7 @@ EXAMPLES_CONFIGURE_WITH= examples - + Default Options The following options are always on by default. @@ -3610,7 +3610,7 @@ EXAMPLES_CONFIGURE_WITH= examples - + Feature Auto-Activation When using a GNU configure script, keep an eye on which @@ -3660,13 +3660,13 @@ FOO_CONFIGURE_ENABLE= foo - + Options Helpers There are some macros to help simplify conditional values which differ based on the options set. - + OPTIONS_SUB If OPTIONS_SUB is set to @@ -3690,7 +3690,7 @@ PLIST_SUB+= OPT1="@comment " NO_OPT1="" .endif - + X_CONFIGURE_ENABLE If X_CONFIGURE_ENABLE is set then @@ -3715,7 +3715,7 @@ CONFIGURE_ARGS+= --disable-test .endif - + X_CONFIGURE_WITH If X_CONFIGURE_WITH is set then @@ -3741,7 +3741,7 @@ CONFIGURE_ARGS+= --without-test .endif - + X_CONFIGURE_ON If X_CONFIGURE_ON is set then its @@ -3763,7 +3763,7 @@ CONFIGURE_ARGS+= --add-test .endif - + X_CONFIGURE_OFF If X_CONFIGURE_OFF is set then its @@ -3785,7 +3785,7 @@ CONFIGURE_ARGS+= --no-test .endif - + X_CMAKE_ON If X_CMAKE_ON is set then its value @@ -3807,7 +3807,7 @@ CMAKE_ARGS+= -DTEST:BOOL=true .endif - + X_CMAKE_OFF If X_CMAKE_OFF is set then its value @@ -3829,7 +3829,7 @@ CMAKE_ARGS+= -DTEST:BOOL=false .endif - + Dependencies For any of the following dependency type: @@ -3910,7 +3910,7 @@ LIB_DEPENDS+= liba.so:${PORTSDIR}/devel/ - + Generic Variables Replacement For any of the following variables: @@ -4070,7 +4070,7 @@ PORTVERSION= 1.0 There are a number of variables you can override if that is not the case. - + <varname>WRKSRC</varname> The variable lists the name of the directory that is @@ -4086,7 +4086,7 @@ PORTVERSION= 1.0 WRKSRC= ${WRKDIR}/${PORTNAME} - + <varname>NO_WRKSUBDIR</varname> If the port does not extract in to a subdirectory at all @@ -4116,7 +4116,7 @@ PORTVERSION= 1.0 those other ports for a few months to cater for users who only update once in a while. - + <varname>CONFLICTS_INSTALL</varname> If your package cannot coexist with other packages @@ -4133,7 +4133,7 @@ PORTVERSION= 1.0 stage and prior to the install stage. - + <varname>CONFLICTS_BUILD</varname> If your port cannot be built if a certain port is already @@ -4146,7 +4146,7 @@ PORTVERSION= 1.0 conflicts are not recorded in the resulting package. - + <varname>CONFLICTS</varname> If your port cannot be built if a certain port is already 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 Thu Mar 20 19:37:47 2014 (r44304) +++ head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Fri Mar 21 13:26:41 2014 (r44305) @@ -84,7 +84,7 @@ COMMENT= Cat chasing a mouse all over th pkg- prefix distinguishes them from other files. - + <filename>pkg-descr</filename> This is a longer description of the port. One to a few @@ -135,7 +135,7 @@ the screen. WWW: http://www.oneko.org/ - + <filename>pkg-plist</filename> This file lists all the files installed by the port. It Modified: head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml Thu Mar 20 19:37:47 2014 (r44304) +++ head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml Fri Mar 21 13:26:41 2014 (r44305) @@ -264,7 +264,7 @@ &prompt.user; cp file file.orig - + Automatic Patch Generation When all the files have been modified, use make @@ -274,7 +274,7 @@ - + Manual Patch Generation Patches are saved into files named @@ -348,7 +348,7 @@ - + General Rules for Patching Try to minimize the amount of non-functional whitespace @@ -368,7 +368,7 @@ - + Simple Automatic Replacements Simple replacements can be performed directly from the Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Thu Mar 20 19:37:47 2014 (r44304) +++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Fri Mar 21 13:26:41 2014 (r44305) @@ -167,7 +167,7 @@ In situations like this, the variables described in the following sections can be set. - + <varname>NO_PACKAGE</varname> This variable indicates that we may not generate a @@ -193,7 +193,7 @@ generated. - + <varname>NO_CDROM</varname> This variable alone indicates that, although we are @@ -215,7 +215,7 @@ only. - + <varname>NOFETCHFILES</varname> Files defined in the NOFETCHFILES @@ -228,7 +228,7 @@ files and not report about them. - + <varname>RESTRICTED</varname> Set this variable alone if the application's license @@ -250,7 +250,7 @@ EULA. - + <varname>RESTRICTED_FILES</varname> When RESTRICTED or @@ -261,7 +261,7 @@ - + <varname>LEGAL_TEXT</varname> If the port has legal concerns not addressed by the @@ -272,7 +272,7 @@ so. - + <filename>/usr/ports/LEGAL</filename> and <varname>LEGAL</varname> @@ -284,7 +284,7 @@ make -VLEGAL. - + Examples The preferred way to state "the distfiles for this port @@ -785,7 +785,7 @@ CMAKE_SOURCE_PATH= ${WRKSRC}/subp Using GNU <literal>gettext</literal> - + Basic Usage If your port requires gettext, set @@ -816,7 +816,7 @@ LDFLAGS+= -L${LOCALBASE}/lib GNU_CONFIGURE= yes - + Optional Usage Some software products allow for disabling NLS, e.g., @@ -882,7 +882,7 @@ PLIST_SUB+= NLS="@comment " generation. - + Handling Message Catalog Directories There is a point to note about installing message @@ -1156,7 +1156,7 @@ USE_XORG= x11 xpm in front. - + X11 Fonts If your port installs fonts for the X Window System, put @@ -1164,7 +1164,7 @@ USE_XORG= x11 xpm LOCALBASE/lib/X11/fonts/local. - + Getting a Fake <envar>DISPLAY</envar> with Xvfb Some applications require a working X11 display for @@ -1198,7 +1198,7 @@ USE_XORG= x11 xpm encouraged for applications which can be used in a desktop environment. - + Using Predefined <filename>.desktop</filename> Files @@ -2280,7 +2280,7 @@ do-install: Similarly, there is a defined policy regarding the CATEGORIES of a Java port, which is - detailed in . + detailed in . @@ -2517,7 +2517,7 @@ do-install: - + PEAR Modules Porting PEAR modules is a very simple process. @@ -4655,7 +4655,7 @@ run_rc_command "$1" _enable variable is not optional, and should use the ":" for the default. - + Pre-Commit Checklist Before contributing a port with an