From owner-svn-doc-head@FreeBSD.ORG Thu Aug 14 13:13:25 2014 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 ESMTPS id 92ABCAE7; Thu, 14 Aug 2014 13:13:25 +0000 (UTC) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (Client did not present a certificate) by mx1.freebsd.org (Postfix) with ESMTPS id 7CCC02565; Thu, 14 Aug 2014 13:13:25 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id s7EDDPHG090156; Thu, 14 Aug 2014 13:13:25 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by svn.freebsd.org (8.14.9/8.14.9/Submit) id s7EDDNoU090148; Thu, 14 Aug 2014 13:13:23 GMT (envelope-from mat@FreeBSD.org) Message-Id: <201408141313.s7EDDNoU090148@svn.freebsd.org> X-Authentication-Warning: svn.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Thu, 14 Aug 2014 13:13:23 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r45455 - in head/en_US.ISO8859-1/books/porters-handbook: makefiles pkg-files plist porting-dads quick-porting slow-porting special uses 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.18-1 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, 14 Aug 2014 13:13:25 -0000 Author: mat (ports committer) Date: Thu Aug 14 13:13:23 2014 New Revision: 45455 URL: http://svnweb.freebsd.org/changeset/doc/45455 Log: Whitespace-only fixes, indentation and wrapping long lines. Translators, please ignore. Sponsored by: Absolight Differential Revision: https://phabric.freebsd.org/605 Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -3546,10 +3546,9 @@ OPT5_DESC= Describe OPT5 OPT6_DESC= Describe OPT6 ports/Mk/bsd.options.desc.mk - has descriptions for many common - OPTIONS. While often useful, they - should be overridden if the description is insufficient - for the port. + has descriptions for many common OPTIONS. + While often useful, they should be overridden if the + description is insufficient for the port. When describing options, view it from the @@ -3823,8 +3822,8 @@ SUB_LIST+= OPT1="@comment " NO_OPT1="" USE_KEY variable will be set to value. If value has spaces in it, - replace them with commas, they will be changed back to spaces - during processing. For example: + replace them with commas, they will be changed back to + spaces during processing. For example: OPTIONS_DEFINE= OPT1 OPT1_USE= mysql=yes xorg=x11,xextproto,xext,xrandr @@ -3884,7 +3883,7 @@ CONFIGURE_ARGS+= --disable-test on the status of the option OPT. An optional argument can be specified with an - = symbol. This argument is only appended + = symbol. This argument is only appended to the --with-opt configure option. For example: Modified: head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/pkg-files/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -12,8 +12,8 @@ The <filename>pkg-*</filename> Files There are some tricks we have not mentioned yet about the - pkg-* files that come in handy - sometimes. + pkg-* files that + come in handy sometimes. <filename>pkg-message</filename> @@ -84,16 +84,20 @@ Changing the Names of - <filename>pkg-<replaceable>*</replaceable></filename> Files + pkg-* + Files - All the names of pkg-* files are + All the names of + pkg-* files are defined using variables so you can change them in your Makefile if need be. This is especially - useful when you are sharing the same pkg-* - files among several ports or have to write to one of the above - files (see writing to places - other than WRKDIR for why it is a - bad idea to write directly into the pkg-* + useful when you are sharing the same + pkg-* files + among several ports or have to write to one of the above files + (see writing to places other than + WRKDIR for why it is a bad idea to + write directly into the + pkg-* subdirectory). Here is a list of variable names and their default values. Modified: head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/plist/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -28,16 +28,18 @@ 4.9). %%PERL_VERSION%% and %%PERL_VER%% is the full version number of perl (e.g., 5.8.9). - Several other %%VARS%% related to port's - documentation files are described in - the relevant + Several other + %%VARS%% related + to port's documentation files are described in the relevant section. If you need to make other substitutions, you can set the PLIST_SUB variable with a list of - VAR=VALUE pairs and instances of - %%VAR%% will be substituted with - VALUE in the + VAR=VALUE + pairs and instances of + %%VAR%% will be + substituted with VALUE in the pkg-plist. For instance, if you have a port that installs many files @@ -97,11 +99,12 @@ OPTIONS_SUB= yes PLIST contents. Names listed in PLIST_FILES, PLIST_DIRS, and PLIST_DIRSTRY are subject to - %%VAR%% substitution as described above. - Except for that, names from PLIST_FILES will - appear in the final packing list unchanged, while - @dirrm and @dirrmtry will - be prepended to names from PLIST_DIRS and + %%VAR%% + substitution as described above. Except for that, names from + PLIST_FILES will appear in the final packing + list unchanged, while @dirrm and + @dirrmtry will be prepended to names from + PLIST_DIRS and PLIST_DIRSTRY, respectively. To take effect, PLIST_FILES, PLIST_DIRS, and PLIST_DIRSTRY must be set before @@ -294,14 +297,14 @@ etc/orbit.conf-dist can get it wrong. User configuration files should be installed as - filename.sample, as it is described in - . The + filename.sample, + as it is described in . The info/dir file should not be listed and appropriate install-info lines should be - added as noted in the - info files section. Any - libraries installed by the port should be listed as specified in - the shared libraries + added as noted in the info + files section. Any libraries installed by the port + should be listed as specified in the shared libraries section. Modified: head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/porting-dads/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -36,9 +36,9 @@ xlink:href="&url.books.handbook;/ports-using.html#PORTS-CD"> 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. + one of the pkg-* + files, do so by redefining a + variable, not by writing over it. @@ -48,10 +48,12 @@ Most ports do not have to worry about this. In particular, if you are referring to a WRKDIR of another port, note that the correct location is - WRKDIRPREFIXPORTSDIR/subdir/name/work not - PORTSDIR/subdir/name/work or - .CURDIR/../../subdir/name/work or some - such. + WRKDIRPREFIXPORTSDIR/subdir/name/work + not + PORTSDIR/subdir/name/work + or + .CURDIR/../../subdir/name/work + or some such. Also, if you are defining WRKDIR yourself, make sure you prepend @@ -386,9 +388,9 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD BROKEN is reserved for ports that - currently do not compile, install, deinstall, or run correctly. - It should be used for ports where the problem is believed - to be temporary. + currently do not compile, install, deinstall, or run + correctly. It should be used for ports where the problem + is believed to be temporary. If instructed, the build cluster will still attempt to try to build them to see if the underlying problem has Modified: head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -21,9 +21,10 @@ The following steps assume that the software compiled - out-of-the-box. In other words, absolutely no changes were required - for the application to work on a &os; system. If anything had to be - changed, refer to . + out-of-the-box. In other words, absolutely no changes were + required for the application to work on a &os; system. If + anything had to be changed, refer to . @@ -208,8 +209,8 @@ PLIST_DIRS= lib/X11/oneko The price for this way of listing a port's files and - directories is that then command sequences - described in &man.pkg-create.8; cannot be used. Therefore, it is suitable + directories is that then command sequences described in + &man.pkg-create.8; cannot be used. Therefore, it is suitable only for simple ports and makes them even simpler. At the same time, it has the advantage of reducing the number of files in the ports collection. Please consider using this @@ -294,7 +295,8 @@ PLIST_DIRS= lib/X11/oneko - pkg add package-filename + pkg add + package-filename Modified: head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/slow-porting/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -59,8 +59,8 @@ The patch target is run. First, any patches defined in PATCHFILES are applied. Second, if any patch files named - patch-* are found in - PATCHDIR (defaults to the + patch-* are + found in PATCHDIR (defaults to the files subdirectory), they are applied at this time in alphabetical order. @@ -170,8 +170,8 @@ Get the original sources (normally) as a compressed tarball (foo.tar.gz or - foo.tar.bz2) and copy it into - DISTDIR. Always use + foo.tar.bz2) and + copy it into DISTDIR. Always use mainstream sources when and where you can. @@ -344,7 +344,7 @@ Manual patch creation is usually not necessary. Automatic patch generation as described earlier in this - section is the preferred method. However, manual patching + section is the preferred method. However, manual patching may be required occasionally. @@ -369,8 +369,8 @@ &prompt.user; diff -u -N newfile.orig newfile > patch-pathname-newfile - Do not add $FreeBSD$ RCS strings in - patches. When patches are added to the + Do not add $FreeBSD$ RCS + strings in patches. When patches are added to the Subversion repository with svn add, the fbsd:nokeywords property is set to Modified: head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/special/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -810,8 +810,9 @@ CMAKE_SOURCE_PATH= ${WRKSRC}/subp libtool (search for a file named ltmain.sh) need to have USES=libtool. Also, if a port has USE_AUTOTOOLS=libtoolize it probably also - needs USES=libtool. See the USES=libtool - section in for more details. + needs USES=libtool. See the USES=libtool section in for more details. @@ -1342,9 +1343,10 @@ USE_XORG= x11 xpm Updating Desktop Database 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. + portname.desktop, + the desktop database must be updated after install and + deinstall. To do this, define USES= + desktop-file-utils. @@ -1352,9 +1354,10 @@ USE_XORG= x11 xpm DESKTOP_ENTRIES Macro Desktop entries can be easily created for applications - by using the DESKTOP_ENTRIES variable. A - file named name.desktop will be - created, installed, and added to the + by using the DESKTOP_ENTRIES variable. A + file named + name.desktop + will be created, installed, and added to the pkg-plist automatically. Syntax is: Modified: head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Thu Aug 14 13:10:48 2014 (r45454) +++ head/en_US.ISO8859-1/books/porters-handbook/uses/chapter.xml Thu Aug 14 13:13:23 2014 (r45455) @@ -987,13 +987,14 @@ GSSAPI_NONE_CONFIGURE_ON= --without-gssa (none), Z, bz2, bzip2, lzma, - tbz, tgz, txz, - xz + tbz, tgz, + txz, xz Set EXTRACT_SUFX to .tar, .tar.Z, - .tar.bz2, .tar.bz2, .tar.lzma, - .tbz, .tgz, .txz or + .tar.bz2, .tar.bz2, + .tar.lzma, .tbz, + .tgz, .txz or .tar.xz respectively.