From owner-svn-doc-head@FreeBSD.ORG Thu Aug 29 00:52:21 2013 Return-Path: Delivered-To: svn-doc-head@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 ESMTP id 7C28FECE; Thu, 29 Aug 2013 00:52:21 +0000 (UTC) (envelope-from wblock@FreeBSD.org) 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 67956250F; Thu, 29 Aug 2013 00:52:21 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id r7T0qLoX013894; Thu, 29 Aug 2013 00:52:21 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.5/Submit) id r7T0qLa0013893; Thu, 29 Aug 2013 00:52:21 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201308290052.r7T0qLa0013893@svn.freebsd.org> From: Warren Block Date: Thu, 29 Aug 2013 00:52:21 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r42601 - head/en_US.ISO8859-1/books/porters-handbook X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.14 Precedence: list List-Id: SVN commit messages for the doc tree for head List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 29 Aug 2013 00:52:21 -0000 Author: wblock Date: Thu Aug 29 00:52:20 2013 New Revision: 42601 URL: http://svnweb.freebsd.org/changeset/doc/42601 Log: Whitespace-only fixes. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/book.xml Wed Aug 28 15:19:37 2013 (r42600) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Thu Aug 29 00:52:20 2013 (r42601) @@ -88,8 +88,9 @@ tab setting: Emacs and Vim should recognize the setting on loading the file. Both &man.vi.1; and &man.ex.1; can be set - to use the correct value by typing :set - tabstop=4 once the file has been loaded. + to use the correct value by typing + :set tabstop=4 once the file has been + loaded. @@ -151,8 +152,8 @@ MANCOMPRESSED= yes contents of the $FreeBSD$ line, it will be filled in automatically by SVN when the port is imported to our main ports tree. You can find a more - detailed example in the sample Makefile + detailed example in the + sample Makefile section. @@ -163,8 +164,8 @@ MANCOMPRESSED= yes any port, whether they actually package or not. They are pkg-descr and pkg-plist. Their - pkg- prefix distinguishes them from - other files. + pkg- prefix distinguishes them from other + files. <filename>pkg-descr</filename> @@ -193,13 +194,12 @@ MANCOMPRESSED= yes runtime environment, or implementation languages help users decide whether this port will work for them. - Include a URL to the official WWW homepage. - Prepend one of - the websites (pick the most common one) with - WWW: (followed by single space) so that - automated tools will work correctly. If the URI is the root - of the website or directory, it should be terminated with a - slash. + Include a URL to the official WWW homepage. Prepend + one of the websites (pick the most + common one) with WWW: (followed by single + space) so that automated tools will work correctly. If the + URI is the root of the website or directory, it should be + terminated with a slash. If the listed webpage for a port is not available, try @@ -397,12 +397,13 @@ PLIST_DIRS= lib/X11/onekoportlint Please use portlint to see if your port - conforms to our guidelines. The ports-mgmt/portlint program is - part of the ports collection. In particular, you may want to - check if the Makefile - is in the right shape and the package is named + conforms to our guidelines. The + ports-mgmt/portlint + program is part of the ports collection. In particular, you + may want to check if the + Makefile is in the + right shape and the + package is named appropriately. @@ -410,8 +411,8 @@ PLIST_DIRS= lib/X11/onekoSubmitting the New Port Before you submit the new port, make sure you have read - the DOs and DON'Ts section. + the DOs and DON'Ts + section. Now that you are happy with your port, the only thing remaining is to put it in the main &os; ports tree and make @@ -421,8 +422,8 @@ PLIST_DIRS= lib/X11/onekocd to the directory above where the oneko directory is located, and then type - the following: shar `find oneko` > - oneko.shar + the following: + shar `find oneko` > oneko.shar Include your oneko.shar file in a bug report and send it with the &man.send-pr.1; program (see @@ -450,9 +451,9 @@ PLIST_DIRS= lib/X11/onekoOne more time, do not include the original source distfile, the work directory, or - the package you built with make - package; and, do use &man.shar.1; for - new ports, not &man.diff.1;. + the package you built with + make package; and, do use + &man.shar.1; for new ports, not &man.diff.1;. After you have submitted your port, please be patient. Sometimes it can take a few months before a port is included @@ -655,19 +656,19 @@ PLIST_DIRS= lib/X11/onekoMASTER_SITES. If you can, try to talk the port author out of doing this; it really does help to establish some kind of source code control. Hosting your own - version will prevent users from getting checksum - mismatch errors, and also reduce the workload of - maintainers of our FTP site. Also, if there is only one - master site for the port, it is recommended that you house a - backup at your site and list it as the second + version will prevent users from getting + checksum mismatch errors, and also + reduce the workload of maintainers of our FTP site. Also, if + there is only one master site for the port, it is recommended + that you house a backup at your site and list it as the second MASTER_SITES. If your port requires some additional `patches' that are available on the Internet, fetch them too and put them in DISTDIR. Do not worry if they come from a site other than where you got the main source tarball, we have - a way to handle these situations (see the description of PATCHFILES + a way to handle these situations (see the description of + PATCHFILES below). @@ -853,8 +854,8 @@ DOS2UNIX_REGEX= .*\.(c|cpp|h)Configuring the Makefile is pretty simple, and again we suggest that you look at existing examples - before starting. Also, there is a sample Makefile in this + before starting. Also, there is a + sample Makefile in this handbook, so take a look and please follow the ordering of variables and sections in that template to make your port easier for others to read. @@ -1109,16 +1110,16 @@ PORTREVISION= 1 A new version is released by the vendor, numbered 0.2 (it turns out the author actually intended 0.10 to actually mean - 0.1.0, not what comes after - 0.9 - oops, too late now). Since the new minor - version 2 is numerically less than the - previous version 10, the - PORTEPOCH must be bumped to manually - force the new package to be detected as - newer. Since it is a new vendor release of - the code, PORTREVISION is reset to 0 - (or removed from the - Makefile). + 0.1.0, not + what comes after 0.9 - oops, too late now). + Since the new minor version 2 is + numerically less than the previous version + 10, the PORTEPOCH + must be bumped to manually force the new package to be + detected as newer. Since it is a new + vendor release of the code, + PORTREVISION is reset to 0 (or removed + from the Makefile). PORTNAME= gtkmumble PORTVERSION= 0.2 @@ -1162,9 +1163,9 @@ PORTEPOCH= 1 PORTVERSION to form PKGNAME as ${PKGNAMEPREFIX}${PORTNAME}${PKGNAMESUFFIX}-${PORTVERSION}. - Make sure this conforms to our guidelines for a good package - name. In particular, you are + Make sure this conforms to our + guidelines for a good + package name. In particular, you are not allowed to use a hyphen (-) in PORTVERSION. Also, if the package name has the @@ -1202,8 +1203,8 @@ PORTEPOCH= 1 use. By setting NO_LATEST_LINK, no link will be generated, which may be an option for all but the main version. Note that how to choose a - main version — most - popular, best supported, + main version — + most popular, best supported, least patched, and so on — is outside the scope of this handbook's recommendations; we only tell you how to specify the other ports' versions after you have @@ -1499,8 +1500,8 @@ PORTEPOCH= 1 This list also determines where in the ports tree the port is imported. If you put more than one category here, it is assumed that the port files will be put in the - subdirectory with the name in the first category. See below for more + subdirectory with the name in the first category. See + below for more discussion about how to pick the right categories. @@ -1706,8 +1707,8 @@ PORTEPOCH= 1 gnome* - Ports from the GNOME + Ports from the + GNOME Project. @@ -1781,8 +1782,8 @@ PORTEPOCH= 1 kde* - Ports from the KDE + Ports from the + KDE Project. @@ -2119,9 +2120,9 @@ PORTEPOCH= 1 xfce* - Ports related to the Xfce desktop - environment. + Ports related to the + Xfce + desktop environment. @@ -2485,6 +2486,7 @@ MASTER_SITE_SUBDIR= makeMASTER_SITES= SF/stardict/WyabdcRealPeopleTTS/${PORTVERSION} This can be also written as + MASTER_SITES= SF MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION} @@ -2691,9 +2693,9 @@ EXTRACT_ONLY= source.tar.gzMASTER_SITES:n) - (Consider this to be a somewhat advanced - topic; those new to this document may wish to skip - this section at first). + (Consider this to be a somewhat + advanced topic; those new to this document + may wish to skip this section at first). This section has information on the fetching mechanism known as both MASTER_SITES:n and @@ -3522,8 +3524,8 @@ ALWAYS_KEEP_DISTFILES= yes checks because it is known to be broken, add: PORTSCOUT= ignore:8.2 - + When specific versions or specific major and minor revisions of a distfile should be checked. For @@ -3533,8 +3535,8 @@ ALWAYS_KEEP_DISTFILES= yes &os;, add: PORTSCOUT= limit:^0\.6\.4 - + When URLs listing the available versions differ from the download URLs. For example, to limit @@ -3574,10 +3576,9 @@ ALWAYS_KEEP_DISTFILES= yes LIB_DEPENDS= libjpeg.so:${PORTSDIR}/graphics/jpeg will check for a shared jpeg library with any version, - and descend into the - graphics/jpeg subdirectory of your - ports tree to build and install it if it is not found. - + and descend into the graphics/jpeg + subdirectory of your ports tree to build and install it if + it is not found. The dependency is checked twice, once from within the extract target and then from within @@ -3661,8 +3662,8 @@ ALWAYS_KEEP_DISTFILES= yes variables, which are processed by ports/Mk/bsd.*.mk to augment initial build dependencies. For example, - USES= gmake adds devel/gmake to + USES= gmake adds + devel/gmake to BUILD_DEPENDS. To prevent such additional dependencies from polluting RUN_DEPENDS, take care to assign with @@ -4111,9 +4112,9 @@ MASTERDIR= ${.CURDIR}/../xdvi300 automatically add any manpages to pkg-plist (this means you must not list manpages in the - pkg-plist—see generating PLIST for more). It - also makes the install stage automatically compress or + pkg-plist—see + generating PLIST for more). + It also makes the install stage automatically compress or uncompress manpages depending on the setting of NO_MANCOMPRESS in /etc/make.conf. @@ -4518,7 +4519,6 @@ CONFIGURE_ARGS+= --without-examples .include <bsd.port.mk> - @@ -4604,15 +4604,17 @@ CONFIGURE_ARGS+= --disable-foo Under some circumstances, the shorthand conditional - syntax can cause problems with complex constructs. - If you receive errors such as Malformed - conditional, an alternative syntax can be - used. + syntax can cause problems with complex constructs. If you + receive errors such as + Malformed conditional, an alternative + syntax can be used. + .if !empty(VARIABLE:MVALUE) # as an alternative to .if ${VARIABLE:MVALUE} + Options Helpers @@ -4620,8 +4622,8 @@ CONFIGURE_ARGS+= --disable-foo values which differ based on the options set. If OPTIONS_SUB is set to - yes then each of the options added - to OPTIONS_DEFINE will be added to + yes then each of the options added + to OPTIONS_DEFINE will be added to PLIST_SUB, for example: OPTIONS_DEFINE= OPT1 @@ -4640,10 +4642,10 @@ PLIST_SUB+= OPT1="@comment " .endif If X_CONFIGURE_ENABLE is set then - --enable-${X_CONFIGURE_ENABLE} - or --disable-${X_CONFIGURE_ENABLE} will - be added to CONFIGURE_ARGS depending on - the value of the optionX, for example: + --enable-${X_CONFIGURE_ENABLE} or + --disable-${X_CONFIGURE_ENABLE} will be + added to CONFIGURE_ARGS depending on the + value of the optionX, for example: OPTIONS_DEFINE= OPT1 OPT1_CONFIGURE_ENABLE= test @@ -4663,7 +4665,7 @@ CONFIGURE_ARGS+= --disable-test If X_CONFIGURE_WITH is set then --with-${X_CONFIGURE_WITH} or --without-${X_CONFIGURE_WITH} will - be added to CONFIGURE_ARGS depending + be added to CONFIGURE_ARGS depending on the status of the option X, for example: @@ -4682,10 +4684,10 @@ CONFIGURE_ARGS+= --with-test CONFIGURE_ARGS+= --without-test .endif - If X_CONFIGURE_ON is set then its value - will be appended to CONFIGURE_ARGS depending - on the status of the option X, for example: - + If X_CONFIGURE_ON is set then its + value will be appended to CONFIGURE_ARGS + depending on the status of the option X, + for example: OPTIONS_DEFINE= OPT1 OPT1_CONFIGURE_ON= --add-test @@ -4700,10 +4702,10 @@ OPT1_CONFIGURE_ON= --add-test - If X_CONFIGURE_OFF is set then its value - will be appended to CONFIGURE_ARGS depending - on the status of the option X, for example: - + If X_CONFIGURE_OFF is set then its + value will be appended to CONFIGURE_ARGS + depending on the status of the option X, + for example: OPTIONS_DEFINE= OPT1 OPT1_CONFIGURE_OFF= --no-test @@ -4718,8 +4720,8 @@ CONFIGURE_ARGS+= --no-test If X_CMAKE_ON is set then its value will be appended to CMAKE_ARGS depending - on the status of the option X, for example: - + on the status of the option X, for + example: OPTIONS_DEFINE= OPT1 OPT1_CMAKE_ON= -DTEST:BOOL=true @@ -4736,8 +4738,8 @@ CMAKE_ARGS+= -DTEST:BOOL=true If X_CMAKE_OFF is set then its value will be appended to CMAKE_ARGS depending - on the status of the option X, for example: - + on the status of the option X, for + example: OPTIONS_DEFINE= OPT1 OPT1_CMAKE_OFF= -DTEST:BOOL=false @@ -4755,33 +4757,33 @@ CMAKE_ARGS+= -DTEST:BOOL=false For any of the following variables: - - CFLAGS - + + CFLAGS + - - CXXFLAGS - + + CXXFLAGS + - - LDLAGS - + + LDLAGS + - - CONFIGURE_ENV - + + CONFIGURE_ENV + - - MAKE_ENV - + + MAKE_ENV + - - USES - + + USES + - - DISTFILES - + + DISTFILES + If X_ABOVEVARIABLE is defined then @@ -4807,33 +4809,33 @@ CFLAGS+= -DTEST For any of the following dependency type: - - PKG_DEPENDS - + + PKG_DEPENDS + - - EXTRACT_DEPENDS - + + EXTRACT_DEPENDS + - - PATCH_DEPENDS - + + PATCH_DEPENDS + - - FETCH_DEPENDS - + + FETCH_DEPENDS + - - BUILD_DEPENDS - + + BUILD_DEPENDS + - - LIB_DEPENDS - + + LIB_DEPENDS + - - RUN_DEPENDS - + + RUN_DEPENDS + If X_ABOVEVARIABLE is defined then @@ -5188,8 +5190,8 @@ PORTVERSION= 1.0 share/doc/PORTNAME will be substituted for %%DOCSDIR%% in the packing list by default, and so on. (See more on - pkg-plist substitution here.) + pkg-plist substitution + here.) All conditionally installed documentation files and directories should be included in @@ -5229,8 +5231,8 @@ PORTVERSION= 1.0 PORTEXAMPLES, respectively. You can also use the pkg-message - file to display messages upon installation. See the section on using + file to display messages upon installation. See + the section on using pkg-message for details. The pkg-message file does not need to be added to pkg-plist. @@ -5304,9 +5306,9 @@ PORTVERSION= 1.0 Please double-check, often this is not necessary at all or can be avoided through -rpath or setting - LD_RUN_PATH during linking (see lang/moscow_ml for an example), or - through a shell-wrapper which sets + LD_RUN_PATH during linking (see + lang/moscow_ml for an + example), or through a shell-wrapper which sets LD_LIBRARY_PATH before invoking the binary, like www/seamonkey does. @@ -5530,12 +5532,13 @@ IGNORE= may not be redistributed because Imakefile files using imake, then set USES= imake. This will cause the - configure stage to automatically do an xmkmf - -a. If the flag is a - problem for your port, set XMKMF=xmkmf. - If the port uses imake but does - not understand the install.man - target, NO_INSTALL_MANPAGES=yes should be + configure stage to automatically do an + xmkmf -a. If the + flag is a problem for your port, set + XMKMF=xmkmf. If the port uses + imake but does not understand the + install.man target, + NO_INSTALL_MANPAGES=yes should be set. If your port's source Makefile has @@ -5676,8 +5679,8 @@ IGNORE= may not be redistributed because lower-cased value of CMAKE_BUILD_TYPE is exported to the PLIST_SUB and should be used if port installs *.cmake files - depending on the build type (see deskutils/strigi for an + depending on the build type (see + deskutils/strigi for an example). Please note that some projects may define their own build profiles and/or force particular build type by setting CMAKE_BUILD_TYPE in @@ -5999,9 +6002,9 @@ GNU_CONFIGURE= yes through passing to configure. In that case, your port should use gettext conditionally, - depending on the status of the NLS option. - For ports of low to medium complexity, you can rely on the - following idiom: + depending on the status of the NLS + option. For ports of low to medium complexity, you can rely + on the following idiom: GNU_CONFIGURE= yes @@ -6052,7 +6055,6 @@ PLIST_SUB+= NLS="@comment " reside under LOCALBASE/share/locale, should rarely be created and removed by a port. The most - popular languages have their respective directories listed in PORTSDIR/Templates/BSD.local.dist. @@ -6253,9 +6255,10 @@ PLIST_SUB+= NLS="@comment " The Mesa Project is an effort to provide free OpenGL implementation. You can specify a dependency on various components of this project with USE_GL - variable. Valid options are: glut, glu, glw, glew, - gl and linux. For backwards - compatibility, the value of yes maps to + variable. Valid options are: + glut, glu, glw, glew, gl and + linux. For backwards compatibility, the + value of yes maps to glu. @@ -6299,11 +6302,12 @@ USE_XORG= x11 xpm If your port requires a Motif library, define USES= motif in the Makefile. Default Motif implementation - is x11-toolkits/open-motif. Users - can choose x11-toolkits/lesstif instead by - setting WANT_LESSTIF variable. + is + x11-toolkits/open-motif. + Users can choose + x11-toolkits/lesstif + instead by setting WANT_LESSTIF + variable. The MOTIFLIB variable will be set by bsd.port.mk to reference the @@ -6399,9 +6403,10 @@ USE_XORG= x11 xpm If a port has a MimeType entry in its portname.desktop, - the desktop database must - be updated after install and deinstall. To do this, - define USES= desktop-file-utils. + the desktop database must be updated after install and + deinstall. To do this, define USES= + desktop-file-utils. + @@ -6480,8 +6485,8 @@ USE_XORG= x11 xpm USE_QT4 Specify tool and library dependencies for ports - that use Qt 4. See Qt 4 component + that use Qt 4. See + Qt 4 component selection for more details. @@ -6609,20 +6614,20 @@ PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_RE Component Selection (Qt 4.x Only) - Individual Qt 4 tool and library dependencies - must be specified in the USE_QT4 - variable. Every component - can be suffixed by either _build or - _run, the suffix indicating whether the - component should be depended on at buildtime or runtime, - respectively. If unsuffixed, the component will be depended - on at both build- and runtime. Usually, library components - should be specified unsuffixed, tool components should be - specified with the _build suffix and - plugin components should be specified with the - _run suffix. The most commonly used - components are listed below (all available components are - listed in _USE_QT4_ALL in + Individual Qt 4 tool and library dependencies must be + specified in the USE_QT4 variable. Every + component can be suffixed by either + _build or _run, the + suffix indicating whether the component should be depended + on at buildtime or runtime, respectively. If unsuffixed, + the component will be depended on at both build- and + runtime. Usually, library components should be specified + unsuffixed, tool components should be specified with the + _build suffix and plugin components + should be specified with the _run suffix. + The most commonly used components are listed below (all + available components are listed in + _USE_QT4_ALL in /usr/ports/Mk/bsd.qt.mk): @@ -6682,7 +6687,6 @@ PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_RE xmlXML library -
@@ -6755,7 +6759,6 @@ PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_RE imageformat plugins for GIF, JPEG, MNG and SVG (if the application ships image files) - @@ -6825,9 +6828,9 @@ do-configure: Bogus installation paths. Sometimes data such as icons or .desktop files are by default installed into directories which are not scanned - by XDG-compatible applications. editors/texmaker is an - example for this - look at + by XDG-compatible applications. + editors/texmaker is + an example for this - look at patch-texmaker.pro in the files directory of that port for a template on how to remedy this directly in the @@ -7003,13 +7006,13 @@ do-configure: KDE 4.x ports are installed into KDE4_PREFIX, which is - /usr/local/kde4 currently. - This is achieved by - specifying the kdeprefix component, which - overrides the default PREFIX. The ports - however respect any PREFIX set via - MAKEFLAGS environment variable and/or - make arguments. + /usr/local/kde4 currently. This is + achieved by specifying the kdeprefix + component, which overrides the default + PREFIX. The ports however respect any + PREFIX set via MAKEFLAGS + environment variable and/or make + arguments. <makevar>USE_KDE4</makevar> Example @@ -7050,8 +7053,8 @@ USE_QT4= moc_build qmake_build rcc_build There are several JDKs in the ports collection, from various vendors, and in several versions. If your port must use one of these versions, you can define which one. The - most current version, and &os; default is java/openjdk6. + most current version, and &os; default is + java/openjdk6. Variables Which May be Set by Ports That Use @@ -7064,6 +7067,7 @@ USE_QT4= moc_build qmake_build rcc_build <entry>Means</entry> </row> </thead> + <tbody> <row> <entry><makevar>USE_JAVA</makevar></entry> @@ -7132,6 +7136,7 @@ USE_QT4= moc_build qmake_build rcc_build <entry>Value</entry> </row> </thead> + <tbody> <row> <entry><makevar>JAVA_PORT</makevar></entry> @@ -7149,7 +7154,6 @@ USE_QT4= moc_build qmake_build rcc_build <row> <entry><makevar>JAVA_PORT_OS</makevar></entry> - <entry>The operating system used by the JDK port (e.g., <literal>'native'</literal>).</entry> </row> @@ -7297,6 +7301,7 @@ USE_QT4= moc_build qmake_build rcc_build <entry>Value</entry> </row> </thead> + <tbody> <row> <entry><makevar>JAVASHAREDIR</makevar></entry> @@ -7338,8 +7343,8 @@ USE_QT4= moc_build qmake_build rcc_build default one will be set that simply runs Ant according to <makevar>MAKE_ENV</makevar>, <makevar>MAKE_ARGS</makevar> and <makevar>ALL_TARGET</makevar>. This is similar to the - <makevar>USES= gmake</makevar> mechanism, which is documented - in <xref linkend="building"/>.</para> + <makevar>USES= gmake</makevar> mechanism, which is + documented in <xref linkend="building"/>.</para> </sect2> <sect2 id="java-best-practices"> @@ -7370,14 +7375,14 @@ USE_QT4= moc_build qmake_build rcc_build <para>Regardless of the type of your port (library or application), the additional documentation should be - installed in the <link linkend="install-documentation">same - location</link> as for any other port. The JavaDoc tool is - known to produce a different set of files depending on the - version of the JDK that is used. For ports that do not - enforce the use of a particular JDK, it is therefore a - complex task to specify the packing list - (<filename>pkg-plist</filename>). This is one reason why - porters are strongly encouraged to use the + installed in the + <link linkend="install-documentation">same location</link> + as for any other port. The JavaDoc tool is known to produce + a different set of files depending on the version of the JDK + that is used. For ports that do not enforce the use of a + particular JDK, it is therefore a complex task to specify + the packing list (<filename>pkg-plist</filename>). This is + one reason why porters are strongly encouraged to use the <makevar>PORTDOCS</makevar> macro. Moreover, even if you can predict the set of files that will be generated by <command>javadoc</command>, the size of the resulting @@ -7389,18 +7394,18 @@ USE_QT4= moc_build qmake_build rcc_build good idea to override <makevar>DATADIR</makevar> to <filename>${JAVASHAREDIR}/${PORTNAME}</filename> for Java ports. Indeed, <makevar>DATADIR</makevar> is automatically - added to <makevar>PLIST_SUB</makevar> (documented in <xref - linkend="plist-sub"/>) so you may use + added to <makevar>PLIST_SUB</makevar> (documented in + <xref linkend="plist-sub"/>) so you may use <literal>%%DATADIR%%</literal> directly in <filename>pkg-plist</filename>.</para> <para>As for the choice of building Java ports from source or directly installing them from a binary distribution, there is no defined policy at the time of writing. However, - people from the <ulink - url="http://www.freebsd.org/java/">&os; Java - Project</ulink> encourage porters to have their ports built - from source whenever it is a trivial task.</para> + people from the + <ulink url="http://www.freebsd.org/java/">&os; Java + Project</ulink> encourage porters to have their ports + built from source whenever it is a trivial task.</para> <para>All the features that have been presented in this section are implemented in <filename>bsd.java.mk</filename>. @@ -7568,9 +7573,9 @@ USE_QT4= moc_build qmake_build rcc_build as <makevar>WWWOWN</makevar> and <makevar>WWWGRP</makevar>, in case you need to change the ownership of some files. The default values of both are <literal>www</literal>. If you - want different values for your port, use <literal>WWWOWN?= - myuser</literal> notation, to allow user to override it - easily.</para> + want different values for your port, use + <literal>WWWOWN?= myuser</literal> notation, to allow user + to override it easily.</para> <para>Do not depend on Apache unless the web app explicitly needs Apache. Respect that users may wish to run your web @@ -7590,8 +7595,8 @@ USE_QT4= moc_build qmake_build rcc_build <entry>The port requires PHP. The value <literal>yes</literal> adds a dependency on PHP. The list of required PHP extensions can be specified - instead. Example: <literal>pcre xml - gettext</literal></entry> + instead. Example: + <literal>pcre xml gettext</literal></entry> </row> <row> @@ -7808,8 +7813,8 @@ _DOCSDIR= . <entry><makevar>USE_TWISTED</makevar></entry> <entry>Add dependency on twistedCore. The list of required components can be specified as a value of - this variable. Example: <literal>web lore pair - flow</literal></entry> + this variable. Example: + <literal>web lore pair flow</literal></entry> </row> <row> @@ -7968,7 +7973,6 @@ _DOCSDIR= . <filename>setup.rb</filename>. Common value is <filename>install.rb</filename>.</entry> </row> - </tbody> </tgroup> </table> @@ -8034,7 +8038,6 @@ _DOCSDIR= . <entry>Module examples installation path.</entry> <entry><literal>/usr/local/share/examples/ruby18/patsy</literal></entry> </row> - </tbody> </tgroup> </table> @@ -8049,8 +8052,8 @@ _DOCSDIR= . <para>The <makevar>USE_SDL</makevar> variable is used to autoconfigure the dependencies for ports which use an SDL - based library like <filename - role="package">devel/sdl12</filename> and <filename + based library like + <filename role="package">devel/sdl12</filename> and <filename role="package">x11-toolkits/sdl_gui</filename>.</para> <para>The following SDL libraries are recognized at the @@ -8115,11 +8118,11 @@ _DOCSDIR= . <programlisting>USE_SDL= net mixer</programlisting> - <para>The dependency <filename - role="package">devel/sdl12</filename>, which is required by - <filename role="package">net/sdl_net</filename> and <filename - role="package">audio/sdl_mixer</filename>, is automatically - added as well.</para> + <para>The dependency + <filename role="package">devel/sdl12</filename>, which is + required by <filename role="package">net/sdl_net</filename> + and <filename role="package">audio/sdl_mixer</filename>, is + automatically added as well.</para> <para>If you use <makevar>USE_SDL</makevar>, it will automatically:</para> @@ -8400,9 +8403,9 @@ USE_SDL+= mixer <para>The dependency type can be selected for each component by adding a suffix separated by a semicolon. If not present - then a default type will be used (see <xref - linkend="wx-def-dep-types"/>). The following types are - available:</para> + then a default type will be used (see + <xref linkend="wx-def-dep-types"/>). The following types + are available:</para> <table frame="none"> <title>Available <application>wxWidgets</application> @@ -8979,9 +8982,9 @@ WANT_LUA_VER= 5.0</programlisting> <para>The dependency type can be selected for each component by adding a suffix separated by a semicolon. If not present - then a default type will be used (see <xref - linkend="lua-def-dep-types"/>). The following types are - available:</para> + then a default type will be used (see + <xref linkend="lua-def-dep-types"/>). The following types + are available:</para> <table frame="none"> <title>Available <application>Lua</application> Dependency @@ -9117,8 +9120,8 @@ CONFIGURE_ARGS+= --enable-tolua <title>Defined VariablesThe following variables are available in the port (after - defining one from ). + defining one from + ).
Variables Defined for Ports That Use @@ -9293,9 +9296,10 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR *** DIFF OUTPUT TRUNCATED AT 1000 LINES ***