From af5a0331bab39bf904008c162e923ee7fc9fe9da Mon Sep 17 00:00:00 2001 From: Warren Block Date: Thu, 17 Dec 2015 02:16:45 +0000 Subject: [PATCH] Whitespace-only fixes, translators please ignore. --- .../porters-handbook/special/chapter.xml | 279 +++++++++--------- 1 file changed, 144 insertions(+), 135 deletions(-) diff --git a/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml b/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml index d2c401f9a8..a9c55bef28 100644 --- a/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml +++ b/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml @@ -79,16 +79,15 @@ ${LN} -sf libfoo.so.42 ${STAGEDIR}${PREFIX}/lib/libfoo.so The source path - ${PREFIX}/lib/libfoo.so.42 looks fine but - could, in fact, be incorrect. Absolute paths can point to a - wrong location, like when a remote file system has been - mounted with NFS under a non-root mount + ${PREFIX}/lib/libfoo.so.42 + looks fine but could, in fact, be incorrect. Absolute paths can + point to a wrong location, like when a remote file system has + been mounted with NFS under a non-root mount point. Relative paths are less fragile, and often much shorter. Ports that install kernel modules must prepend - STAGEDIR to - their destination, by default + STAGEDIR to their destination, by default /boot/modules. @@ -679,16 +678,17 @@ IGNORE= may not be redistributed because of licensing reasons. Please visit -Os -DNDEBUG correspondingly. The lower-cased value of CMAKE_BUILD_TYPE is exported to PLIST_SUB and must be - used if the port installs *.cmake + used if the port installs + *.cmake 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 - CMakeLists.txt. To - make a port for such a project respect - CFLAGS and WITH_DEBUG, - the CMAKE_BUILD_TYPE definitions must be + example). Please note that some projects may define their own + build profiles and/or force particular build type by setting + CMAKE_BUILD_TYPE in + CMakeLists.txt. To make a port for such + a project respect CFLAGS and + WITH_DEBUG, the + CMAKE_BUILD_TYPE definitions must be removed from those files. Most CMake-based projects @@ -816,7 +816,8 @@ CMAKE_SOURCE_PATH= ${WRKSRC}/subproject - <command>libtool</command> and <command>libtoolize</command> + <command>libtool</command> and + <command>libtoolize</command> Ports shipping with their own copy of libtool (search for a file named ltmain.sh) need to have @@ -950,13 +951,13 @@ GNU_CONFIGURE= yes Optional Usage - Some software products allow for disabling NLS. For example, - through passing to - configure. In that case, the port - must use gettext conditionally, - depending on the status of the NLS - option. For ports of low to medium complexity, use - this idiom: + Some software products allow for disabling + NLS. For example, through passing + to + configure. In that case, the port must use + gettext conditionally, depending on the + status of the NLS option. For ports of low + to medium complexity, use this idiom: GNU_CONFIGURE= yes @@ -1091,8 +1092,8 @@ PLIST_SUB+= NLS="@comment " PERL_VERSION - The full version of Perl - installed (for example, 5.8.9). + The full version of Perl installed (for example, + 5.8.9). @@ -1111,8 +1112,8 @@ PLIST_SUB+= NLS="@comment " PERL_PORT - Name of the Perl port that is - installed (for example, perl5). + Name of the Perl port that is installed (for + example, perl5). @@ -1337,8 +1338,8 @@ USE_XORG= x11 xpm Files Ports that include predefined - *.desktop must - include those files in pkg-plist + *.desktop + must include those files in pkg-plist and install them in the $LOCALBASE/share/applications directory. The _run suffixes can be used to force components dependency type (for example, baseapps_run). If no suffix is set, a - default dependency type will be used. To force - both types, add the component twice with both suffixes - (for example, automoc4_build automoc4_run). The - most commonly used components are listed below (up-to-date + default dependency type will be used. To force both types, + add the component twice with both suffixes (for example, + automoc4_build automoc4_run). The most + commonly used components are listed below (up-to-date components are documented at the top of /usr/ports/Mk/bsd.kde4.mk): @@ -2859,14 +2860,14 @@ USE_QT4= moc_build qmake_build rcc_build uic_build Variable Definitions If the port needs a Java™ Development Kit - (JDK™) to either build, run or even extract the - distfile, then define + (JDK™) to either build, run or even + extract the distfile, then define USE_JAVA. - There are several JDKs in the ports collection, from - various vendors, and in several versions. If the port must - use one of these versions, define which one. The - most current version, and &os; default is + There are several JDKs in the ports + collection, from various vendors, and in several versions. If + the port must use one of these versions, define which one. + The most current version, and &os; default is java/openjdk6. @@ -2899,35 +2900,37 @@ USE_QT4= moc_build qmake_build rcc_build uic_build JAVA_OS - List of space-separated suitable JDK port - operating systems for the port (allowed values: + List of space-separated suitable + JDK port operating systems for the + port (allowed values: native linux). JAVA_VENDOR - List of space-separated suitable JDK port - vendors for the port (allowed values: + List of space-separated suitable + JDK port vendors for the port + (allowed values: freebsd bsdjava sun openjdk). JAVA_BUILD - When set, add the selected JDK port to the build - dependencies. + When set, add the selected JDK + port to the build dependencies. JAVA_RUN - When set, add the selected JDK port to the run - dependencies. + When set, add the selected JDK + port to the run dependencies. JAVA_EXTRACT - When set, add the selected JDK port to the - extract dependencies. + When set, add the selected JDK + port to the extract dependencies. @@ -2950,28 +2953,30 @@ USE_QT4= moc_build qmake_build rcc_build uic_build JAVA_PORT - The name of the JDK port (for example, - java/openjdk6). + The name of the JDK port (for + example, java/openjdk6). JAVA_PORT_VERSION - The full version of the JDK port (for example, - 1.6.0). Only the first two - digits of this version number are needed, use + The full version of the JDK + port (for example, 1.6.0). Only + the first two digits of this version number are + needed, use ${JAVA_PORT_VERSION:C/^([0-9])\.([0-9])(.*)$/\1.\2/}. JAVA_PORT_OS - The operating system used by the JDK port - (for example, 'native'). + The operating system used by the + JDK port (for example, + 'native'). JAVA_PORT_VENDOR - The vendor of the JDK port (for example, - 'openjdk'). + The vendor of the JDK port + (for example, 'openjdk'). @@ -2983,15 +2988,16 @@ USE_QT4= moc_build qmake_build rcc_build uic_build JAVA_PORT_VENDOR_DESCRIPTION - Description of the vendor of the JDK port - (for example, 'OpenJDK BSD Porting + Description of the vendor of the + JDK port (for example, + 'OpenJDK BSD Porting Team'). JAVA_HOME - Path to the installation directory of the JDK - (for example, + Path to the installation directory of the + JDK (for example, '/usr/local/openjdk6'). @@ -3086,8 +3092,8 @@ USE_QT4= moc_build qmake_build rcc_build uic_build JAVA_CLASSES - Path to the archive that contains the JDK class - files, + Path to the archive that contains the + JDK class files, ${JAVA_HOME}/jre/lib/rt.jar. @@ -3096,7 +3102,8 @@ USE_QT4= moc_build qmake_build rcc_build uic_buildUse the java-debug make target to get information for debugging the port. It will - display the value of many of the previously listed variables. + display the value of many of the previously listed + variables.Additionally, these constants are defined so all Java ports may be installed in a consistent way: @@ -3147,14 +3154,14 @@ USE_QT4= moc_build qmake_build rcc_build uic_buildBuilding with AntWhen the port is to be built using Apache Ant, it has to - define USE_ANT. Ant is thus considered - to be the sub-make command. When no - do-build target is defined by the port, a - default one will be set that runs Ant according to - MAKE_ENV, MAKE_ARGS - and ALL_TARGET. This is similar to the - USES= gmake mechanism, which is - documented in . + define USE_ANT. Ant is thus considered to + be the sub-make command. When no + do-build target is defined by the + port, a default one will be set that runs Ant according to + MAKE_ENV, MAKE_ARGS and + ALL_TARGET. This is similar to the + USES= gmake mechanism, which is documented + in . @@ -3164,11 +3171,11 @@ USE_QT4= moc_build qmake_build rcc_build uic_build the JAR file(s) in ${JAVAJARDIR}, and everything else under ${JAVASHAREDIR}/${PORTNAME} (except for - the documentation, see below). To reduce the - packing file size, reference the JAR file(s) - directly in the Makefile. Use this - statement (where myport.jar - is the name of the JAR file installed as part of the + the documentation, see below). To reduce the packing file + size, reference the JAR file(s) directly in the + Makefile. Use this statement (where + myport.jar is + the name of the JAR file installed as part of the port): PLIST_FILES+= %%JAVAJARDIR%%/myport.jar @@ -3212,18 +3219,18 @@ do-install: @cd ${WRKDIR}/${PORTDIRNAME} && ${COPYTREE_SHARE} \* ${WEBAPPDIR}/${PORTDIRNAME} Regardless of the type of port (library or - application), the additional documentation is - installed in the - same location - 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 (pkg-plist). This is - one reason why porters are strongly encouraged to use - PORTDOCS. Moreover, even if the - set of files that will be generated by - javadoc can be predicted, the size of the resulting + application), the additional documentation is installed in the + same location 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 + (pkg-plist). This is one reason why + porters are strongly encouraged to use + PORTDOCS. Moreover, even if the set of + files that will be generated by javadoc can + be predicted, the size of the resulting pkg-plist advocates for the use of PORTDOCS. @@ -3257,11 +3264,11 @@ do-install: on the &a.java;. Although there is a java category for - PRs, it refers to the JDK porting effort from the &os; Java - project. Therefore, submit the Java port in the - ports category as for any other port, - unless the issue is related to - either a JDK implementation or + PRs, it refers to the JDK porting effort + from the &os; Java project. Therefore, submit the Java port + in the ports category as for any other + port, unless the issue is related to either a + JDK implementation or bsd.java.mk. Similarly, there is a defined policy regarding the @@ -3604,18 +3611,18 @@ SOCKETS_USE= PHP=sockets USES=python - The port needs Python. The minimal required version - can be specified with values such as - 2.7+. Version ranges can also be - specified by separating two version numbers with a - dash: USES=python:3.2-3.3 + The port needs Python. The minimal required + version can be specified with values such as + 2.7+. Version ranges can also be + specified by separating two version numbers with a dash: + USES=python:3.2-3.3 USE_PYTHON=distutils Use Python distutils for configuring, compiling, - and installing. This is required when the port comes - with setup.py. This overrides + and installing. This is required when the port comes + with setup.py. This overrides the do-build and do-install targets and may also override do-configure @@ -3625,22 +3632,23 @@ SOCKETS_USE= PHP=sockets USE_PYTHON=autoplist - Create the packaging list automatically. This also requires - USE_PYTHON=distutils to be set. - + Create the packaging list automatically. This also + requires USE_PYTHON=distutils to be + set. - - USE_PYTHON=concurrent - The port will use an unique prefix, typically - PYTHON_PKGNAMEPREFIX for certain directories, such - as EXAMPLESDIR and DOCSDIR and - also will append a suffix, the python version from - PYTHON_VER, to binaries and scripts to be - installed. This allows ports to be installed for different Python - versions at the same time, which otherwise would install conflicting - files. - + + USE_PYTHON=concurrent + The port will use an unique prefix, typically + PYTHON_PKGNAMEPREFIX for certain + directories, such as EXAMPLESDIR and + DOCSDIR and also will append a + suffix, the python version from + PYTHON_VER, to binaries and scripts + to be installed. This allows ports to be installed for + different Python versions at the same time, which + otherwise would install conflicting files. + PYTHON_PKGNAMEPREFIX @@ -3699,12 +3707,11 @@ SOCKETS_USE= PHP=sockets A complete list of available variables can be found in /usr/ports/Mk/Uses/python.mk. + + Makefile for a Simple <application>Python</application> + Module - - Makefile for a Simple <application>Python</application> - Module - - PORTNAME= sample + PORTNAME= sample PORTVERSION= 1.2.3 CATEGORIES= devel @@ -3715,7 +3722,7 @@ USES= python USE_PYTHON= autoplist distutils .include <bsd.port.mk> - + Some Python applications claim to have DESTDIR support (which would be required @@ -5199,8 +5206,8 @@ USE_XFCE= libexo libmenu libutil panel USE_PGSQL - Retired in favor of - USES=pgsql. + Retired in favor of USES=pgsql. @@ -5340,10 +5347,11 @@ run_rc_command "$1" If this is a new file, does it have a - .sh extension? If so, that - must be changed to just file.in - since rc.d files may not end - with that extension. + .sh extension? If so, that must be + changed to just + file.in + since rc.d files may not end with + that extension. @@ -5399,8 +5407,9 @@ run_rc_command "$1" perl, python, or ruby, make certain that command_interpreter is set - appropriately, for example, for Perl, - by adding PERL=${PERL} to + appropriately, for example, for + Perl, by adding + PERL=${PERL} to SUB_LIST and using %%PERL%%. Otherwise, @@ -5489,12 +5498,12 @@ run_rc_command "$1" Adding Users and Groups - Some ports require a particular user account to be present, usually - for daemons that run as that user. For these ports, choose a - unique UID from 50 to 999 and register it in - ports/UIDs (for users) and - ports/GIDs (for groups). The unique identification - should be the same for users and groups. + Some ports require a particular user account to be present, + usually for daemons that run as that user. For these ports, + choose a unique UID from 50 to 999 and + register it in ports/UIDs (for users) and + ports/GIDs (for groups). The unique + identification should be the same for users and groups. Please include a patch against these two files when requiring a new user or group to be created for the