From 7b067ac76bc37b22e4304606c0dba559bf336fb5 Mon Sep 17 00:00:00 2001 From: Warren Block Date: Thu, 29 Aug 2013 00:52:20 +0000 Subject: [PATCH] Whitespace-only fixes. Translators, please ignore. --- .../books/porters-handbook/book.xml | 939 +++++++++--------- 1 file changed, 470 insertions(+), 469 deletions(-) diff --git a/en_US.ISO8859-1/books/porters-handbook/book.xml b/en_US.ISO8859-1/books/porters-handbook/book.xml index 2499a95b9b..f8f8474832 100644 --- a/en_US.ISO8859-1/books/porters-handbook/book.xml +++ b/en_US.ISO8859-1/books/porters-handbook/book.xml @@ -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/oneko portlint 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/oneko Submitting 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/oneko Next, assuming your port is called oneko, cd 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/oneko One 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/oneko MASTER_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= make MASTER_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.gz Sites and Subdirectories (MASTER_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 CONFIGURE_ARGS+= --add-test .endif - 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 of licensing reasons. Please visit 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 of licensing reasons. Please visit 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_REL} \ 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_REL} \ xmlXML library -
@@ -6755,7 +6759,6 @@ PLIST_SUB+= QT_INCDIR_REL=${QT_INCDIR_REL} \ 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 uic_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 uic_build</programlisting> <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 uic_build</programlisting> <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 uic_build</programlisting> <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 uic_build</programlisting> <entry>Value</entry> </row> </thead> + <tbody> <row> <entry><makevar>JAVASHAREDIR</makevar></entry> @@ -7338,8 +7343,8 @@ USE_QT4= moc_build qmake_build rcc_build uic_build</programlisting> 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 uic_build</programlisting> <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 uic_build</programlisting> 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 uic_build</programlisting> 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 uic_build</programlisting> <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}" <para>The <makevar>USE_XFCE</makevar> variable is used to autoconfigure the dependencies for ports which use an Xfce - based library or application like <filename - role="package">x11-toolkits/libxfce4gui</filename> and - <filename role="package">x11-wm/xfce4-panel</filename>.</para> + based library or application like + <filename role="package">x11-toolkits/libxfce4gui</filename> + and <filename + role="package">x11-wm/xfce4-panel</filename>.</para> <para>The following Xfce libraries and applications are recognized at the moment:</para> @@ -9362,10 +9366,10 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR}" </listitem> </itemizedlist> - <para>Therefore, if a port has a dependency on <filename - role="package">sysutils/xfce4-mcs-manager</filename> and - requires the special CPPFLAGS in its configure environment, - the syntax will be:</para> + <para>Therefore, if a port has a dependency on + <filename role="package">sysutils/xfce4-mcs-manager</filename> + and requires the special CPPFLAGS in its configure + environment, the syntax will be:</para> <programlisting>USE_XFCE= mcsmanager configenv</programlisting> </sect1> @@ -9468,13 +9472,14 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR}" <row> <entry><makevar>USE_BDB</makevar></entry> <entry>If variable is set to <literal>yes</literal>, - add dependency on <filename - role="package">databases/db41</filename> port. The - variable may also be set to values: 40, 41, 42, 43, - 44, 46, 47, 48, or 51. You can declare a range of - acceptable values, <makevar>USE_BDB</makevar>=42+ will - find the highest installed version, and fall back to - 42 if nothing else is installed.</entry> + add dependency on + <filename role="package">databases/db41</filename> + port. The variable may also be set to values: 40, 41, + 42, 43, 44, 46, 47, 48, or 51. You can declare a + range of acceptable values, + <makevar>USE_BDB</makevar>=42+ will find the highest + installed version, and fall back to 42 if nothing else + is installed.</entry> </row> <row> @@ -9546,8 +9551,7 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR}" <literal>%%PREFIX%%</literal> and <literal>%%LOCALBASE%%</literal> expansions is strongly encouraged as well. More on <makevar>SUB_LIST</makevar> in - <link - linkend="using-sub-files">the relevant + <link linkend="using-sub-files">the relevant section</link>.</para> <para>Prior to &os; 6.1-RELEASE, integration with @@ -9693,11 +9697,11 @@ run_rc_command "$1"</programlisting> <step> - <para>Make sure there is no <literal>KEYWORD: - FreeBSD</literal> present. This has not been - necessary or desirable for years. It is also an - indication that the new script was copy/pasted from an - old script, so extra caution should be given to the + <para>Make sure there is no + <literal>KEYWORD: FreeBSD</literal> present. This has + not been necessary or desirable for years. It is also + an indication that the new script was copy/pasted from + an old script, so extra caution should be given to the review.</para> </step> @@ -9854,8 +9858,8 @@ IGNORE= requires kernel sources to be installed of <command>perl</command> (e.g., <literal>5.8.9</literal>). Several other <literal>%%<replaceable>VARS</replaceable>%%</literal> related - to port's documentation files are described in <link - linkend="install-documentation">the relevant + to port's documentation files are described in + <link linkend="install-documentation">the relevant section</link>.</para> <para>If you need to make other substitutions, you can set the @@ -9899,8 +9903,8 @@ PLIST_SUB+= X11="@comment " <programlisting>%%X11%%bin/foo-gui</programlisting> - <para>This substitution (as well as addition of any <link - linkend="makefile-manpages">manual pages</link>) will be + <para>This substitution (as well as addition of any + <link linkend="makefile-manpages">manual pages</link>) will be done between the <maketarget>pre-install</maketarget> and <maketarget>do-install</maketarget> targets, by reading from <filename><makevar>PLIST</makevar></filename> and writing to @@ -10041,10 +10045,10 @@ etc/orbit.conf.sample <para>If there is a very good reason not to install a working configuration file by default, leave the <literal>@exec</literal> line out of - <filename>pkg-plist</filename> and add a <link - linkend="porting-message">message</link> pointing out that - the user must copy and edit the file before the software will - work.</para> + <filename>pkg-plist</filename> and add a + <link linkend="porting-message">message</link> pointing out + that the user must copy and edit the file before the software + will work.</para> </sect1> <sect1 id="plist-dynamic"> @@ -10131,10 +10135,10 @@ etc/orbit.conf.sample <filename><replaceable>filename</replaceable>.sample</filename>. The <filename>info/dir</filename> file should not be listed and appropriate <filename>install-info</filename> lines should - be added as noted in the <link linkend="makefile-info">info - files</link> section. Any libraries installed by the port - should be listed as specified in the <link - linkend="porting-shlibs">shared libraries</link> + be added as noted in the + <link linkend="makefile-info">info files</link> section. Any + libraries installed by the port should be listed as specified + in the <link linkend="porting-shlibs">shared libraries</link> section.</para> <para>Alternatively, use the <command>plist</command> script in @@ -10160,10 +10164,11 @@ etc/orbit.conf.sample stated above.</para> <para>Another tool that might be used to create an initial - <filename>pkg-plist</filename> is <filename - role="package">ports-mgmt/genplist</filename>. As with any - automated tool, the resulting <filename>pkg-plist</filename> - should be checked and manually edited as needed.</para> + <filename>pkg-plist</filename> is + <filename role="package">ports-mgmt/genplist</filename>. As + with any automated tool, the resulting + <filename>pkg-plist</filename> should be checked and manually + edited as needed.</para> </sect1> </chapter> @@ -10411,20 +10416,20 @@ as .putsy.conf and edit it.</programlisting> <filename>/usr/ports/INDEX</filename> which keeps track of such items as port dependencies. <filename>INDEX</filename> is created by the top-level - <filename>ports/Makefile</filename> via <command>make - index</command>, which descends into each port subdirectory - and executes <command>make describe</command> there. Thus, if - <command>make describe</command> fails in any port, no one can - generate <filename>INDEX</filename>, and many people will - quickly become unhappy.</para> + <filename>ports/Makefile</filename> via + <command>make index</command>, which descends into each port + subdirectory and executes <command>make describe</command> + there. Thus, if <command>make describe</command> fails in any + port, no one can generate <filename>INDEX</filename>, and many + people will quickly become unhappy.</para> <note> <para>It is important to be able to generate this file no matter what options are present in <filename>make.conf</filename>, so please avoid doing things such as using <literal>.error</literal> statements when (for - instance) a dependency is not satisfied. (See <xref - linkend="dads-dot-error"/>.)</para> + instance) a dependency is not satisfied. (See + <xref linkend="dads-dot-error"/>.)</para> </note> <para>If <command>make describe</command> produces a string @@ -10445,9 +10450,10 @@ as .putsy.conf and edit it.</programlisting> linkend="porting-portlint"><command>portlint</command></link> before you submit or commit it. <command>portlint</command> warns you about many common errors, both functional and - stylistic. For a new (or repocopied) port, <command>portlint - -A</command> is the most thorough; for an existing port, - <command>portlint -C</command> is sufficient.</para> + stylistic. For a new (or repocopied) port, + <command>portlint -A</command> is the most thorough; for an + existing port, <command>portlint -C</command> is + sufficient.</para> <para>Since <command>portlint</command> uses heuristics to try to figure out errors, it can produce false positive @@ -10460,9 +10466,9 @@ as .putsy.conf and edit it.</programlisting> <sect1 id="testing-porttools"> <title>Port Tools - The ports-mgmt/porttools program is - part of the Ports Collection. + The + ports-mgmt/porttools + program is part of the Ports Collection.port is the front-end script, which can help you simplify the testing job. Whenever you want to test @@ -10561,15 +10567,15 @@ as .putsy.conf and edit it. If you are an avid ports contributor, you might want to take a look at Tinderbox. It is a powerful system for building and testing ports based on the - scripts used on Pointyhat. You can install - Tinderbox using ports-mgmt/tinderbox port. Be - sure to read supplied documentation since the configuration is - not trivial. + scripts used on + Pointyhat. You can + install Tinderbox using + ports-mgmt/tinderbox port. + Be sure to read supplied documentation since the configuration + is not trivial. - Visit the Tinderbox + Visit the + Tinderbox website for more details. @@ -10593,28 +10599,28 @@ as .putsy.conf and edit it. The next step is to see if there is an update already pending. To do this, you have two options. There is a searchable interface to the - FreeBSD Problem Report (PR) database (also known as + url="http://www.FreeBSD.org/cgi/query-pr-summary.cgi?query">FreeBSD + Problem Report (PR) database (also known as GNATS). Select ports in the dropdown, and enter the name of the port.However, sometimes people forget to put the name of the port into the Synopsis field in an unambiguous fashion. In that - case, you can try the FreeBSD Ports - Monitoring System (also known as - portsmon). This system attempts to classify - port PRs by portname. To search for PRs about a particular - port, use the FreeBSD Ports Monitoring System + (also known as portsmon). This system + attempts to classify port PRs by portname. To search for PRs + about a particular port, use the Overview of One Port.If there is no pending PR, the next step is to send an email - to the port's maintainer, as shown by make - maintainer. That person may already be working on - an upgrade, or have a reason to not upgrade the port right now - (because of, for example, stability problems of the new - version); you would not want to duplicate their work. Note that - unmaintained ports are listed with a maintainer of + to the port's maintainer, as shown by + make maintainer. That person may already be + working on an upgrade, or have a reason to not upgrade the port + right now (because of, for example, stability problems of the + new version); you would not want to duplicate their work. Note + that unmaintained ports are listed with a maintainer of ports@FreeBSD.org, which is just the general ports mailing list, so sending mail there probably will not help in this case. @@ -10634,22 +10640,23 @@ as .putsy.conf and edit it.&prompt.user; diff -u something.orig something > something.diff - Otherwise, you should either use the svn - diff method () or copy the - contents of the port to an entire different directory and use - the result of the recursive &man.diff.1; output of the new and - old ports directories (e.g., if your modified port directory is - called superedit and the original is in our - tree as superedit.bak, then save the result - of diff -ruN superedit.bak superedit). - Either unified or context diff is fine, but port committers - generally prefer unified diffs. Note the use of the - -N option—this is the accepted way to - force diff to properly deal with the case of new files being - added or old files being deleted. Before sending us the diff, - please examine the output to make sure all the changes make - sense. (In particular, make sure you first clean out the work - directories with make clean). + Otherwise, you should either use the + svn diff method () + or copy the contents of the port to an entire different + directory and use the result of the recursive &man.diff.1; + output of the new and old ports directories (e.g., if your + modified port directory is called superedit + and the original is in our tree as + superedit.bak, then save the result of + diff -ruN superedit.bak superedit). Either + unified or context diff is fine, but port committers generally + prefer unified diffs. Note the use of the -N + option—this is the accepted way to force diff to properly + deal with the case of new files being added or old files being + deleted. Before sending us the diff, please examine the output + to make sure all the changes make sense. (In particular, make + sure you first clean out the work directories with + make clean).To simplify common operations with patch files, you can use /usr/ports/Tools/scripts/patchtool.py. @@ -10665,7 +10672,7 @@ as .putsy.conf and edit it. url="&url.books.developers-handbook;/policies.html#POLICIES-MAINTAINER"> Developer's Handbook.) - The best way to send us the diff is by including it via + The best way to send us the diff is by including it via &man.send-pr.1; (category ports). If you are maintaining the port, be sure to put [maintainer update] at the beginning of your synopsis line and set @@ -10707,12 +10714,12 @@ as .putsy.conf and edit it. Using <literal>SVN</literal> to Make Patches If you can, please submit a &man.svn.1; diff — they - are easier to handle than diffs between new and - old directories. Plus it is easier for you to see - what you have changed and to update your diff if something is - modified in the Ports Collection from when you started to work - on it until you submit your changes, or if the committer asks - you to fix something. + are easier to handle than diffs between + new and old directories. Plus it is easier for + you to see what you have changed and to update your diff if + something is modified in the Ports Collection from when you + started to work on it until you submit your changes, or if the + committer asks you to fix something. &prompt.user; cd ~/my_wrkdir &prompt.user; svn co https://svn0.us-west.FreeBSD.org/ports/head/dns/pdnsd @@ -10722,8 +10729,8 @@ as .putsy.conf and edit it. This can be anywhere you want, of course; building - ports is not limited to within /usr/ports/. + ports is not limited to within + /usr/ports/. @@ -10868,37 +10875,35 @@ as .putsy.conf and edit it. Bugs are occasionally introduced to the software. Arguably, the most dangerous of them are those opening - security vulnerabilities. From the technical viewpoint, - such vulnerabilities are to be closed by exterminating - the bugs that caused them. However, the policies for - handling mere bugs and security vulnerabilities are - very different. + security vulnerabilities. From the technical viewpoint, such + vulnerabilities are to be closed by exterminating the bugs + that caused them. However, the policies for handling mere + bugs and security vulnerabilities are very different. A typical small bug affects only those users who have - enabled some combination of options triggering the bug. - The developer will eventually release a patch followed - by a new version of the software, free of the bug, but - the majority of users will not take the trouble of upgrading - immediately because the bug has never vexed them. A - critical bug that may cause data loss represents a graver - issue. Nevertheless, prudent users know that a lot of - possible accidents, besides software bugs, are likely to - lead to data loss, and so they make backups of important - data; in addition, a critical bug will be discovered - really soon. + enabled some combination of options triggering the bug. The + developer will eventually release a patch followed by a new + version of the software, free of the bug, but the majority of + users will not take the trouble of upgrading immediately + because the bug has never vexed them. A critical bug that may + cause data loss represents a graver issue. Nevertheless, + prudent users know that a lot of possible accidents, besides + software bugs, are likely to lead to data loss, and so they + make backups of important data; in addition, a critical bug + will be discovered really soon. - A security vulnerability is all different. First, - it may remain unnoticed for years because often it does - not cause software malfunction. Second, a malicious party - can use it to gain unauthorized access to a vulnerable - system, to destroy or alter sensitive data; and in the - worst case the user will not even notice the harm caused. - Third, exposing a vulnerable system often assists attackers - to break into other systems that could not be compromised - otherwise. Therefore closing a vulnerability alone is - not enough: the audience should be notified of it in most - clear and comprehensive manner, which will allow to - evaluate the danger and take appropriate actions. + A security vulnerability is all different. First, it may + remain unnoticed for years because often it does not cause + software malfunction. Second, a malicious party can use it to + gain unauthorized access to a vulnerable system, to destroy or + alter sensitive data; and in the worst case the user will not + even notice the harm caused. Third, exposing a vulnerable + system often assists attackers to break into other systems + that could not be compromised otherwise. Therefore closing a + vulnerability alone is not enough: the audience should be + notified of it in most clear and comprehensive manner, which + will allow to evaluate the danger and take appropriate + actions. @@ -10910,12 +10915,12 @@ as .putsy.conf and edit it. original software developer is likely to release a patch or a new version instantly, and you will only need to update the port promptly with respect to the author's fix. If the fix is - delayed for some reason, you should either mark the port as + delayed for some reason, you should either + mark the port as FORBIDDEN or introduce a patch file of your own to the port. In the case of a vulnerable port, - just fix the port as soon as possible. In either case, the standard procedure for + just fix the port as soon as possible. In either case, + the standard procedure for submitting your change should be followed unless you have rights to commit it directly to the ports tree. @@ -10961,39 +10966,35 @@ as .putsy.conf and edit it. package without delay as soon as a corrected version is available. - Given the huge number of ports in the tree - a security advisory cannot be issued on each incident - without creating a flood and losing the attention of - the audience when it comes to really serious - matters. Therefore security vulnerabilities found in - ports are recorded in the FreeBSD VuXML - database. The Security Officer Team members - also monitor it for issues requiring their - intervention. + Given the huge number of ports in the tree a security + advisory cannot be issued on each incident without creating + a flood and losing the attention of the audience when it + comes to really serious matters. Therefore security + vulnerabilities found in ports are recorded in + the FreeBSD VuXML + database. The Security Officer Team members also + monitor it for issues requiring their intervention. If you have committer rights you can update the VuXML database by yourself. So you will both help the Security Officer Team and deliver the crucial information to the - community earlier. However, if you are not a committer, - or you believe you have found an exceptionally severe - vulnerability please do not hesitate to - contact the Security Officer Team directly as described - on the FreeBSD + community earlier. However, if you are not a committer, or + you believe you have found an exceptionally severe + vulnerability please do not hesitate to contact the Security + Officer Team directly as described on the + FreeBSD Security Information page. - The VuXML database is an - XML document. Its source file vuln.xml - is kept right inside the port security/vuxml. Therefore - the file's full pathname will be + The VuXML database is an XML document. Its source file + vuln.xml is kept right inside the port + security/vuxml. + Therefore the file's full pathname will be PORTSDIR/security/vuxml/vuln.xml. - Each time you discover a security vulnerability in a - port please add an entry for it to that file. - Until you are familiar with VuXML, the best thing you can - do is to find an existing entry fitting your case, then copy - it and use it as a template. + Each time you discover a security vulnerability in a port + please add an entry for it to that file. Until you are + familiar with VuXML, the best thing you can do is to find an + existing entry fitting your case, then copy it and use it as + a template. @@ -11065,9 +11066,9 @@ as .putsy.conf and edit it. </dates> </vuln> - The tag names are supposed to be self-explanatory - so we shall take a closer look only at fields you will need - to fill in by yourself: + The tag names are supposed to be self-explanatory so we + shall take a closer look only at fields you will need to + fill in by yourself: @@ -11210,8 +11211,8 @@ as .putsy.conf and edit it. - This is a MITRE + This is a + MITRE CVE identifier. @@ -11228,20 +11229,20 @@ as .putsy.conf and edit it. - This is a US-CERT + This is a + US-CERT vulnerability note. - This is a US-CERT + This is a + US-CERT Cyber Security Alert. - This is a US-CERT + This is a + US-CERT Technical Cyber Security Alert. @@ -11288,8 +11289,8 @@ as .putsy.conf and edit it.install fresh versions of the ports ports-mgmt/portaudit, ports-mgmt/portaudit-db, - and security/vuxml. + and + security/vuxml. To run packaudit you must have @@ -11329,9 +11330,9 @@ as .putsy.conf and edit it. You will need at least one of the following packages - installed: textproc/libxml2, textproc/jade. + installed: + textproc/libxml2, + textproc/jade. Now rebuild the portaudit database @@ -11363,8 +11364,8 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 1 problem(s) found. - The former version should match while the - latter one should not. + The former version should match while the latter one + should not. Finally, verify whether the web page generated from the VuXML database looks like expected: @@ -11386,12 +11387,12 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 during the porting process. You should check your own port against this list, but you can also check ports in the PR - database that others have submitted. Submit any + database that others have submitted. Submit any comments on ports you check as described in Bug - Reports and General Commentary. Checking ports in the - PR database will both make it faster for us to commit them, - and prove that you know what you are doing. + Reports and General Commentary. Checking ports in + the PR database will both make it faster for us to commit + them, and prove that you know what you are doing. @@ -11400,15 +11401,15 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 Do not write anything to files outside WRKDIR. WRKDIR is the only place that is guaranteed to be writable during the port - build (see + build (see + installing ports from a CDROM for an example of building ports from a read-only tree). If you need to modify one of the pkg-* files, - do so by redefining a variable, not - by writing over it. + do so by + redefining a variable, + not by writing over it. @@ -11522,11 +11523,11 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 described above. If there actually is a FreeBSD specific change (such as special shared library options when using ld) then it is OK to use - __FreeBSD__ and #if - __FreeBSD__ > 1 to detect a FreeBSD 2.x and - later system. If you need more granularity in detecting - FreeBSD systems since 2.0-RELEASE you can use the - following: + __FreeBSD__ and + #if __FreeBSD__ > 1 to detect a + FreeBSD 2.x and later system. If you need more + granularity in detecting FreeBSD systems since 2.0-RELEASE + you can use the following: #if __FreeBSD__ >= 2 #include <osreldate.h> @@ -16314,9 +16315,9 @@ Reference: <http://www.freebsd.org/ports/portaudit/74a9541d-5d6c-11d8-80e3-00 1000051 August 25, 2013 10-CURRENT after Radeon KMS driver import - (rev 254885, 254887). + (rev 254885, + 254887). -
@@ -16490,8 +16491,9 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@" globally. If the port does not respect these variables, - please add NO_PACKAGE=ignores either cc or - cxx to the Makefile. + please add + NO_PACKAGE=ignores either cc or cxx to the + Makefile. An example of a Makefile respecting both CC and CXX @@ -16528,8 +16530,8 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@" needs to the existing value. This is so that build options that affect all ports can be set globally. - If it does not, please add NO_PACKAGE=ignores - cflags to the + If it does not, please add + NO_PACKAGE=ignores cflags to the Makefile. An example of a Makefile respecting @@ -16731,7 +16733,7 @@ exec %%LOCALBASE%%/bin/java -jar %%DATADIR%%/foo.jar "$@" installed port (for example, if they install a file in the same place that performs a different function), use - CONFLICTS instead. + CONFLICTS instead. CONFLICTS will set IGNORE by itself. @@ -16968,7 +16970,6 @@ IGNORE= POINTYHAT is not supported Compile threaded applications with -pthread, not -lpthread or variations thereof. - @@ -16985,7 +16986,6 @@ IGNORE= POINTYHAT is not supported Please be careful to note any legal issues! Do not let us illegally distribute software! - @@ -16998,8 +16998,8 @@ IGNORE= POINTYHAT is not supported It is recommended that you follow this format (ordering of variables, empty lines between sections, etc.). This format is designed so that the most important information is easy to - locate. We recommend that you use portlint to check the + locate. We recommend that you use + portlint to check the Makefile. [the header...just to make it easier for us to identify the ports.] @@ -17093,9 +17093,9 @@ pre-install: FreshPorts One of the easiest ways to learn about updates that have - already been committed is by subscribing to FreshPorts. You - can select multiple ports to monitor. Maintainers are + already been committed is by subscribing to + FreshPorts. + You can select multiple ports to monitor. Maintainers are strongly encouraged to subscribe, because they will receive notification of not only their own changes, but also any changes that any other &os; committer has made. (These are @@ -17160,9 +17160,9 @@ pre-install: an entire cluster of machines is dedicated to continually building the Ports Collection, for each of the major OS releases and for each Tier-1 architecture. You can find - the results of these builds at package building logs - and errors. + the results of these builds at + package building + logs and errors. Individual ports are built unless they are specifically marked with IGNORE. Ports that are @@ -17178,13 +17178,13 @@ pre-install: The build cluster is dedicated to building the latest release of each port with distfiles that have already been fetched. However, as the Internet continually changes, - distfiles can quickly go missing. Portscout, the - &os; Ports distfile scanner, attempts to query every download - site for every port to find out if each distfile is still - available. Portscout can generate - HTML reports and send emails about newly - available ports to those who request them. Unless not + distfiles can quickly go missing. + Portscout, + the &os; Ports distfile scanner, attempts to query every + download site for every port to find out if each distfile is + still available. Portscout can + generate HTML reports and send emails about + newly available ports to those who request them. Unless not otherwise subscribed, maintainers are asked to check periodically for changes, either by hand or using the RSS feed. @@ -17197,12 +17197,12 @@ pre-install: email address for a specific maintainer, and for selecting whether or not only out-of-date ports should be shown. - Upon clicking on a maintainer's email address, - a list of all of their ports is displayed, along with port - category, current version number, whether or not there is a - new version, when the port was last updated, and finally when - it was last checked. A search function on this page allows - the user to search for a specific port. + Upon clicking on a maintainer's email address, a list of + all of their ports is displayed, along with port category, + current version number, whether or not there is a new version, + when the port was last updated, and finally when it was last + checked. A search function on this page allows the user to + search for a specific port. Clicking on a port name in the list displays the FreshPorts port @@ -17212,21 +17212,21 @@ pre-install: The &os; Ports Monitoring System - Another handy resource is the FreeBSD Ports Monitoring - System (also known as portsmon). - This system comprises a database that processes information - from several sources and allows it to be browsed via a web - interface. Currently, the ports Problem Reports (PRs), the - error logs from the build cluster, and individual files from - the ports collection are used. In the future, this will be - expanded to include the distfile survey, as well as other - sources. + Another handy resource is the + FreeBSD Ports + Monitoring System (also known as + portsmon). This system comprises a + database that processes information from several sources and + allows it to be browsed via a web interface. Currently, the + ports Problem Reports (PRs), the error logs from the build + cluster, and individual files from the ports collection are + used. In the future, this will be expanded to include the + distfile survey, as well as other sources. To get started, you can view all information about a particular port by using the - Overview of One Port. + url="http://portsmon.FreeBSD.org/portoverview.py">Overview + of One Port. As of this writing, this is the only resource available that maps GNATS PR entries to portnames. (PR submitters do @@ -17256,6 +17256,7 @@ pre-install: Description + &values.uses;