From owner-svn-doc-all@FreeBSD.ORG Sun Dec 8 19:16:14 2013 Return-Path: Delivered-To: svn-doc-all@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 495D257D; Sun, 8 Dec 2013 19:16:14 +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)) (No client certificate requested) by mx1.freebsd.org (Postfix) with ESMTPS id 2916D182B; Sun, 8 Dec 2013 19:16:14 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id rB8JGEVb008642; Sun, 8 Dec 2013 19:16:14 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.7/Submit) id rB8JGD7n008638; Sun, 8 Dec 2013 19:16:13 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201312081916.rB8JGD7n008638@svn.freebsd.org> From: Warren Block Date: Sun, 8 Dec 2013 19:16:13 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r43303 - head/en_US.ISO8859-1/books/porters-handbook X-SVN-Group: doc-head MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit X-BeenThere: svn-doc-all@freebsd.org X-Mailman-Version: 2.1.17 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: Sun, 08 Dec 2013 19:16:14 -0000 Author: wblock Date: Sun Dec 8 19:16:13 2013 New Revision: 43303 URL: http://svnweb.freebsd.org/changeset/doc/43303 Log: Miscellaneous fixes included punctuation, adding missing articles, removing some instances of "you", corrections for clarity. Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml Modified: head/en_US.ISO8859-1/books/porters-handbook/book.xml ============================================================================== --- head/en_US.ISO8859-1/books/porters-handbook/book.xml Sun Dec 8 18:04:01 2013 (r43302) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Sun Dec 8 19:16:13 2013 (r43303) @@ -138,8 +138,7 @@ This setting enables the developer mode that displays deprecation warnings and activates some further - quality checks on calling the make - command. + quality checks on calling make. @@ -2551,7 +2550,7 @@ MASTER_SITE_SUBDIR= makeMASTER_SITES= SF/stardict/WyabdcRealPeopleTTS/${PORTVERSION} - This can be also written as + This can also be written as MASTER_SITES= SF MASTER_SITE_SUBDIR= stardict/WyabdcRealPeopleTTS/${PORTVERSION} @@ -3927,7 +3926,7 @@ ALWAYS_KEEP_DISTFILES= yes installed when default C/C++ compiler is Clang); or yes (means always use stable, modern GCC from lang/gcc port). - The exact version can be also specified, with a + The exact version can also be specified, with a value such as 4.7. The minimal required version can be specified as 4.6+. The GCC from the base @@ -5293,11 +5292,11 @@ PORTVERSION= 1.0 PORTDATA and PORTEXAMPLES, respectively. - You can also use the pkg-message - file to display messages upon installation. See + The contents of pkg-message + are displayed upon installation. See the section on using - pkg-message for details. The - pkg-message file does not need to be + pkg-message for details. + pkg-message does not need to be added to pkg-plist. @@ -7150,7 +7149,7 @@ USE_QT4= qmake_build - smokekde + smokekde KDE SMOKE libraries @@ -7981,8 +7980,7 @@ _DOCSDIR= . (cd ${STAGEDIR}${PREFIX} \ && ${PYTHON_CMD} ${PYTHON_LIBDIR}/compileall.py \ - -d ${PREFIX} -f ${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;}) - + -d ${PREFIX} -f ${PYTHONPREFIX_SITELIBDIR:S;${PREFIX}/;;}) This recompiles the sources with a path relative to the stage directory, and prepends the value of @@ -9817,8 +9815,8 @@ post-patch: USE_MYSQL - If variable is set to yes, add - dependency on + If the variable is set to yes, add + a dependency on the databases/mysql55-client port. An associated variable, WANT_MYSQL_VER, may be set to @@ -9866,7 +9864,7 @@ post-patch: framework. Details on its usage can be found in the rc.d Handbook chapter. Detailed explanation of - available commands is provided in &man.rc.8; and + the available commands is provided in &man.rc.8; and &man.rc.subr.8;. Finally, there is an article on practical aspects of @@ -10850,7 +10848,7 @@ as .putsy.conf and edit it.Handbook. - This will have the added benefit of tracking all the ports' + This will have the added benefit of tracking all the port's dependencies. The next step is to see if there is an update already @@ -10942,17 +10940,17 @@ as .putsy.conf and edit it. - Before you &man.send-pr.1;, you should review the Before using &man.send-pr.1;, review the Writing the problem report section in the Problem - Reports article; it contains far more information about how to + Reports article. It contains far more information about how to write useful problem reports. - If your upgrade is motivated by security concerns or a + If the upgrade is motivated by security concerns or a serious fault in the currently committed port, please notify the &a.portmgr; to request immediate rebuilding and - redistribution of your port's package. Unsuspecting users + redistribution of the port's package. Unsuspecting users of &man.pkg.add.1; will otherwise continue to install the old version via pkg_add -r for several weeks. @@ -10964,7 +10962,7 @@ as .putsy.conf and edit it. - Now that you have done all that, you will want to read about + Now that you have done all that, read about how to keep up-to-date in . @@ -11223,12 +11221,12 @@ as .putsy.conf and edit it. - Given the huge number of ports in the tree a security + 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 + the &os; VuXML database. The Security Officer Team members also monitor it for issues requiring their intervention. @@ -11240,15 +11238,15 @@ as .putsy.conf and edit it.FreeBSD + xlink:href="http://www.freebsd.org/security/#how">&os; Security Information page. - The VuXML database is an XML document. Its source file + 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 + 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 @@ -11258,7 +11256,7 @@ as .putsy.conf and edit it. A Short Introduction to VuXML - The full-blown XML format is complex, and far beyond the + The full-blown XML format is complex, and far beyond the scope of this book. However, to gain basic insight on the structure of a VuXML entry you need only the notion of tags. XML tag names are enclosed in angle brackets. Each opening @@ -11458,13 +11456,13 @@ as .putsy.conf and edit it. This is a FreeBSD + xlink:href="http://www.freebsd.org/security/#adv">&os; security advisory. This is a FreeBSD + xlink:href="http://www.freebsd.org/support.html#gnats">&os; problem report. @@ -11641,9 +11639,9 @@ Reference: <http://www.freebsd.org/po Introduction - Here is a list of common dos and don'ts that you encounter - during the porting process. You should check your own port - against this list, but you can also check ports in the Here is a list of common dos and don'ts that are encountered + during the porting process. Check the port + against this list, but also check ports in the PR database that others have submitted. Submit any comments on ports you check as described in __FreeBSD__ is defined to be 9. - - #if __FreeBSD__ >= 9 + #if __FreeBSD__ >= 9 # if __FreeBSD_version >= 901000 /* 9.1+ release specific code here */ # endif #endif - @@ -11981,9 +11977,9 @@ exec %%LOCALBASE%%/bin/java -jar %%DATAD <filename>README.html</filename> - Do not include the README.html file. - This file is not part of the SVN collection but is generated - using the make readme command. + README.html is not part of the port, + but generated by make readme. Do not + include this file in patches or commits. If make readme fails, make sure that