From owner-svn-doc-all@FreeBSD.ORG Fri Sep 14 17:27:39 2012 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2001:4f8:fff6::34]) by hub.freebsd.org (Postfix) with ESMTP id A65311065672; Fri, 14 Sep 2012 17:27:39 +0000 (UTC) (envelope-from wblock@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:4f8:fff6::2c]) by mx1.freebsd.org (Postfix) with ESMTP id 8749B8FC0A; Fri, 14 Sep 2012 17:27:39 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.4/8.14.4) with ESMTP id q8EHRdmb070606; Fri, 14 Sep 2012 17:27:39 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.4/8.14.4/Submit) id q8EHRd1H070604; Fri, 14 Sep 2012 17:27:39 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201209141727.q8EHRd1H070604@svn.freebsd.org> From: Warren Block Date: Fri, 14 Sep 2012 17:27:39 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Cc: Subject: svn commit: r39542 - head/en_US.ISO8859-1/books/porters-handbook X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.5 Precedence: list List-Id: "SVN commit messages for the entire doc trees \(except for " user" , " projects" , and " translations" \)" List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 14 Sep 2012 17:27:39 -0000 Author: wblock Date: Fri Sep 14 17:27:38 2012 New Revision: 39542 URL: http://svn.freebsd.org/changeset/doc/39542 Log: Whitespace-only fixes: indentation, wrapping long lines, adding blank lines. Translators, please ignore. Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml Modified: head/en_US.ISO8859-1/books/porters-handbook/book.sgml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/book.sgml Fri Sep 14 17:09:52 2012 (r39541) +++ head/en_US.ISO8859-1/books/porters-handbook/book.sgml Fri Sep 14 17:27:38 2012 (r39542) @@ -3419,38 +3419,46 @@ ALWAYS_KEEP_DISTFILES= yes This is a one-line description of the port. Please respect the following rules: - - - Try to keep the COMMENT value at no longer than 70 - characters, as this line will be used by the - &man.pkg.info.1; utility to display a one-line summary - of the port; - - - Do not include the package - name (or version number of the software); - - - The comment should begin with a capital and end - without a period; - - - Do not start with an indefinite article (i.e. - A or An); - - - Names are capitalized (e.g. Apache, JavaScript, - Perl); - - - For lists of words use the Oxford comma (e.g. - green, red, and blue); - - - Spell check the text. - - - Here is an example: + + + + Try to keep the COMMENT value at no longer than 70 + characters, as this line will be used by the + &man.pkg.info.1; utility to display a one-line summary + of the port; + + + + Do not include the package + name (or version number of the software); + + + + The comment should begin with a capital and end + without a period; + + + + Do not start with an indefinite article (i.e. + A or An); + + + + Names are capitalized (e.g. Apache, JavaScript, + Perl); + + + + For lists of words use the Oxford comma (e.g. + green, red, and blue); + + + + Spell check the text. + + + + Here is an example: COMMENT= Cat chasing a mouse all over the screen @@ -3548,12 +3556,12 @@ ALWAYS_KEEP_DISTFILES= yes The lib part is a regular expression which is being looked up in the ldconfig -r output. Values such as - intl.9 and intl.[5-7] - are allowed. The first pattern, - intl.9, will match only version 9 of - intl, while - intl.[5-7], will match any of: - intl.5, intl.6 or + intl.9 and + intl.[5-7] are allowed. The first + pattern, intl.9, will match only + version 9 of intl, while intl.[5-7], + will match any of: intl.5, + intl.6 or intl.7. @@ -3589,8 +3597,8 @@ ALWAYS_KEEP_DISTFILES= yes xmlcatmgr:${PORTSDIR}/textproc/xmlcatmgr will check if the file or directory - /usr/local/news/bin/innd exists, and build - and install it from the news/inn + /usr/local/news/bin/innd exists, and + build and install it from the news/inn subdirectory of the ports tree if it is not found. It will also see if an executable called xmlcatmgr is in the search path, and @@ -3839,22 +3847,22 @@ ALWAYS_KEEP_DISTFILES= yes in , while autoconf, automake and - libtool are described in . + libtool are described in + . Perl related variables are - described in . X11 variables are - listed in . deals with GNOME and with KDE related variables. documents Java variables, while - contains information on + described in . X11 variables + are listed in . + deals with GNOME and + with KDE related variables. + documents Java variables, while + contains information on Apache, PHP and PEAR modules. - Python is discussed in , while - Ruby in . provides - variables used for SDL + Python is discussed in + , while + Ruby in + . + provides variables used for SDL applications and finally, contains information on Xfce. @@ -4555,9 +4563,9 @@ CONFIGURE_ARGS+= --enable-foo the make config dialog. But the application's configure script detects the library present in the system and includes its support in the resulting - executable. Now when the user decides to remove libfoo from the - system, the ports system does not protest (no dependency on - libfoo was recorded) but the application breaks. + executable. Now when the user decides to remove libfoo from + the system, the ports system does not protest (no dependency + on libfoo was recorded) but the application breaks. Correct Handling of an Option @@ -5594,19 +5602,26 @@ IGNORE= may not be redistributed because USE_PKGCONFIG= yes - The ports uses pkg-config only at build time + The ports uses pkg-config only at build + time + USE_PKGCONFIG= build - The ports uses pkg-config only at build time + The ports uses pkg-config only at build + time + USE_PKGCONFIG= run - The ports uses pkg-config only at run time + The ports uses pkg-config only at run + time + USE_PKGCONFIG= both - The ports uses pkg-config both at build and run time + The ports uses pkg-config both at build and run + time @@ -6532,8 +6547,8 @@ do-configure: build target. Qt applications often are written to be cross-platform - and often X11/Unix is not the platform they are developed on, - which in turn often leads to certain loose ends, + and often X11/Unix is not the platform they are developed + on, which in turn often leads to certain loose ends, like: @@ -7114,10 +7129,11 @@ QT_COMPONENTS= moc_build qmake_build rcc yes (gets any version), 20, 22, 20-22, 20+, - etc. The default APACHE version is - 22. More details are available in - ports/Mk/bsd.apache.mk and at - wiki.freebsd.org/Apache/. + etc. The default APACHE version is + 22. More details are available + in ports/Mk/bsd.apache.mk and + at wiki.freebsd.org/Apache/. @@ -8283,7 +8299,8 @@ CONFIGURE_ARGS+= --enable-wxpython Defined Variables The following variables are available in the port (after - defining one from ). + defining one from + ). Variables Defined for Ports That Use @@ -9169,8 +9186,8 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR role="package">databases/postgresql90-client</filename> port. An associated variable, <makevar>WANT_PGSQL_VER</makevar>, may be set to - values such as 83, 84, 90, 91 or 92. You can declare a - minimum or maximum value; + values such as 83, 84, 90, 91 or 92. You can declare + a minimum or maximum value; <makevar>WANT_PGSQL_VER</makevar>= <literal> 90+</literal> will cause the port to depend on a minimum version of 9.0.</entry> @@ -10398,8 +10415,8 @@ as .putsy.conf and edit it.</programlist <sect1 id="svn-diff"> <title>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 + 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 @@ -10419,7 +10436,8 @@ as .putsy.conf and edit it. - svn.FreeBSD.org + svn.FreeBSD.org is a public SVN server. @@ -10443,8 +10461,8 @@ as .putsy.conf and edit it.This will try to merge the differences between your patch and current SVN; watch the output carefully. The letter in front of each file name indicates what was done - with it. See for a complete - list. + with it. See for a + complete list. @@ -10483,10 +10501,11 @@ as .putsy.conf and edit it.If you get C as a result of svn update it means something changed in the SVN repository and &man.svn.1; was not able to merge your - local changes and those from the repository. It is always a good idea - to inspect the changes anyway, since &man.svn.1; + local changes and those from the repository. It is always a + good idea to inspect the changes anyway, since &man.svn.1; does not know anything about how a port should be, so it might - (and probably will) merge things that do not make sense. + (and probably will) merge things that do not make + sense.The last step is to make a unified &man.diff.1; of the files against SVN: @@ -15966,10 +15985,10 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD FORBIDDEN is used for ports that - contain a security vulnerability or induce grave - concern regarding the security of a FreeBSD system with - a given port installed (e.g., a reputably insecure program - or a program that provides easily exploitable services). + contain a security vulnerability or induce grave concern + regarding the security of a FreeBSD system with a given + port installed (e.g., a reputably insecure program or a + program that provides easily exploitable services). Ports should be marked as FORBIDDEN as soon as a particular piece of software has a vulnerability and there is no released upgrade. Ideally @@ -16236,8 +16255,8 @@ IGNORE= POINTYHAT is not supported if it is missing. Check the man pages to - see if the function used is a POSIX + url="http://www.freebsd.org/cgi/man.cgi">man pages + to see if the function used is a POSIX interface (in the STANDARDS section of the man page).