From owner-svn-doc-all@FreeBSD.ORG Sun Jan 12 20:30:37 2014 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [8.8.178.115]) (using TLSv1 with cipher ADH-AES256-SHA (256/256 bits)) (No client certificate requested) by hub.freebsd.org (Postfix) with ESMTPS id ACA14F78; Sun, 12 Jan 2014 20:30:37 +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 8D5731F00; Sun, 12 Jan 2014 20:30:37 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id s0CKUb05099084; Sun, 12 Jan 2014 20:30:37 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.7/Submit) id s0CKUbxB099083; Sun, 12 Jan 2014 20:30:37 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201401122030.s0CKUbxB099083@svn.freebsd.org> From: Warren Block Date: Sun, 12 Jan 2014 20:30:37 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r43482 - 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, 12 Jan 2014 20:30:37 -0000 Author: wblock Date: Sun Jan 12 20:30:37 2014 New Revision: 43482 URL: http://svnweb.freebsd.org/changeset/doc/43482 Log: Whitespace-only cleanup, translators please ignore. 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 Jan 12 20:13:18 2014 (r43481) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Sun Jan 12 20:30:37 2014 (r43482) @@ -168,9 +168,10 @@ COMMENT= Cat chasing a mouse all over th See if you can figure it out. Do not worry about the contents of the $FreeBSD$ - line, it will be filled in automatically by Subversion when the port - is imported to our main ports tree. You can find a more - detailed example in the + line, it will be filled in automatically by + Subversion when the port is + imported to our main ports tree. You can find a more detailed + example in the sample Makefile section. @@ -422,8 +423,8 @@ PLIST_DIRS= lib/X11/onekoThorough automated testing can be done with ports-mgmt/tinderbox or - ports-mgmt/poudriere from the Ports - Collection. These applications maintain + ports-mgmt/poudriere from the + Ports Collection. These applications maintain jails where all of the steps shown above can be tested without affecting the state of the host system. @@ -451,14 +452,17 @@ PLIST_DIRS= lib/X11/onekoDOs and DON'Ts section. - Once happy with your port, the only thing - remaining is to put it in the main &os; ports tree and make - everybody else happy about it too. We do not need the + Once happy with your port, the only thing remaining is to + put it in the main &os; ports tree and make everybody else + happy about it too. We do not need the work directory or the - pkgname.tgz package, so delete them now. - Next, build the &man.shar.1; file. Assuming the port is called oneko, - cd to the directory above where the - oneko directory is located, and then type: + pkgname.tgz package, so delete them + now. + + Next, build the &man.shar.1; file. Assuming the port is + called oneko, cd to the + directory above where the oneko directory + is located, and then type: shar `find oneko` > oneko.shar Include oneko.shar in a bug @@ -467,23 +471,24 @@ PLIST_DIRS= lib/X11/onekoBug Reports and General Commentary for more information about &man.send-pr.1;. - Classify the bug report - as Category ports and Class - change-request. Do not mark the report - confidential! Add a short - description of the program to the - Description field of the PR (perhaps a - short version of the COMMENT), and add - the .shar file to the Fix field. + + Classify the bug report as Category + ports and Class + change-request. Do + not mark the report + confidential! Add a short description of + the program to the Description field of the PR (perhaps a + short version of the COMMENT), and add the + .shar file to the Fix field. - Giving a good - description in the synopsis of the problem report makes the work of port committers a lot easier. We + Giving a good description in the synopsis of the problem + report makes the work of port committers a lot easier. We prefer something like New port: <category>/<portname> <short description of the port> for new ports. Using this - scheme makes it easier and faster to begin the work of committing - the new port. + scheme makes it easier and faster to begin the work of + committing the new port. One more time, do not include the original @@ -492,15 +497,15 @@ PLIST_DIRS= lib/X11/onekomake package; and, do use &man.shar.1; for new ports, not &man.diff.1;. - After submitting the port, please be patient. The time needed - to include a new port in &os; can vary from a few days to a - a few months. The list - of pending port PRs can be viewed at After submitting the port, please be patient. The time + needed to include a new port in &os; can vary from a few days + to a a few months. The list of pending port + PRs can be viewed at . - After looking at the new port, we will reply - if necessary, and put it in the tree. Your name will also - be added to the list of After looking at the new port, we will reply if necessary, + and put it in the tree. Your name will also be added to the + list of Additional &os; Contributors and other files. @@ -786,10 +791,11 @@ PLIST_DIRS= lib/X11/onekopatch-ab etc, always mention the path and file name in patch names. - Do not put RCS strings in patches. Subversion will mangle them - when we put the files into the ports tree, and when we check - them out again, they will come out different and the patch - will fail. RCS strings are surrounded by dollar + Do not put RCS strings in patches. + Subversion will mangle them when we + put the files into the ports tree, and when we check them out + again, they will come out different and the patch will fail. + RCS strings are surrounded by dollar ($) signs, and typically start with $Id or $RCS. @@ -817,9 +823,10 @@ PLIST_DIRS= lib/X11/onekoSubversion repository but makes it hard to - find out what exactly caused the problem and what you changed - at all. + increases the size of the + Subversion repository but makes it + hard to find out what exactly caused the problem and what you + changed at all. If you had to delete a file, then you can do it in the post-extract target rather than as @@ -4295,8 +4302,8 @@ MASTERDIR= ${.CURDIR}/../xdvi300 WITH_OPENSSL_PORT Installs the version of OpenSSL from - security/openssl, even - if the base is up to date. + security/openssl, + even if the base is up to date. @@ -5624,12 +5631,13 @@ IGNORE= may not be redistributed because This is achieved by passing -jX flag to &man.make.1; running on vendor code. This is the default - build behavior of ports. Unfortunately, not all ports handle - parallel building well and it may be required to explicitly - disable this feature by adding the - MAKE_JOBS_UNSAFE=yes variable. It is used - when a port is known to be broken with + build behavior of ports. Unfortunately, not all ports + handle parallel building well and it may be required to + explicitly disable this feature by adding the + MAKE_JOBS_UNSAFE=yes variable. It is + used when a port is known to be broken with -jX. + @@ -7575,10 +7583,11 @@ USE_QT4= moc_build qmake_build rcc_build If you ever think that your port needs more sophisticated Java support, please first have a look at the bsd.java.mk - Subversion log as it usually takes some time to document - the latest features. Then, if you think the support you are - lacking would be beneficial to many other Java ports, feel - free to discuss it on the &a.java;. + Subversion log as it + usually takes some time to document the latest features. + Then, if you think the support you are lacking would be + beneficial to many other Java ports, feel free to discuss it + on the &a.java;. Although there is a java category for PRs, it refers to the JDK porting effort from the &os; Java @@ -8227,8 +8236,8 @@ _DOCSDIR= . The USE_SDL variable is used to autoconfigure the dependencies for ports which use an SDL - based library like devel/sdl12 and - graphics/sdl_image. + based library like devel/sdl12 + and graphics/sdl_image. The following SDL libraries for version 1.2 are recognized at the moment: @@ -8239,19 +8248,23 @@ _DOCSDIR= . - console: devel/sdl_console + console: devel/sdl_console - gfx: graphics/sdl_gfx + gfx: graphics/sdl_gfx - image: graphics/sdl_image + image: graphics/sdl_image - mixer: audio/sdl_mixer + mixer: audio/sdl_mixer @@ -8263,16 +8276,18 @@ _DOCSDIR= . - pango: - x11-toolkits/sdl_pango + pango: x11-toolkits/sdl_pango - sound: audio/sdl_sound + sound: audio/sdl_sound - ttf: graphics/sdl_ttf + ttf: graphics/sdl_ttf @@ -8285,23 +8300,28 @@ _DOCSDIR= . - gfx: graphics/sdl2_gfx + gfx: graphics/sdl2_gfx - image: graphics/sdl2_image + image: graphics/sdl2_image - mixer: audio/sdl2_mixer + mixer: audio/sdl2_mixer - net: net/sdl2_net + net: net/sdl2_net - ttf: graphics/sdl2_ttf + ttf: graphics/sdl2_ttf @@ -8459,17 +8479,20 @@ USE_SDL+= mixer 2.4 - x11-toolkits/wxgtk24 + x11-toolkits/wxgtk24 2.6 - x11-toolkits/wxgtk26 + x11-toolkits/wxgtk26 2.8 - x11-toolkits/wxgtk28 + x11-toolkits/wxgtk28 @@ -9037,12 +9060,14 @@ PLIST_SUB+= VERSION="${VER_STR}" 4.0 - lang/lua4 + lang/lua4 5.0 - lang/lua50 + lang/lua50 @@ -9506,16 +9531,16 @@ CFLAGS+= -DLUA_VERSION_STRING="${VER_STR After 2013-10-08 (254273), &os;  10-CURRENT and newer versions have a native iconv in the operating system. On earlier - versions, converters/libiconv was used as a - dependency. + versions, converters/libiconv + was used as a dependency. For software that needs iconv, define USES=iconv. &os; versions before 10-CURRENT on 2013-08-13 (254273) do not have a native iconv. On these earlier versions, a dependency on - converters/libiconv will be added - automatically. + converters/libiconv will be + added automatically. When a port defines USES=iconv, these variables will be available: @@ -9655,41 +9680,48 @@ post-patch: - libexo: x11/libexo + libexo: x11/libexo - libgui: - x11-toolkits/libxfce4gui + libgui: x11-toolkits/libxfce4gui - libutil: x11/libxfce4util + libutil: x11/libxfce4util - libmcs: x11/libxfce4mcs + libmcs: x11/libxfce4mcs - mcsmanager: - sysutils/xfce4-mcs-manager + mcsmanager: sysutils/xfce4-mcs-manager - panel: x11-wm/xfce4-panel + panel: x11-wm/xfce4-panel - thunar: x11-fm/thunar + thunar: x11-fm/thunar - wm: x11-wm/xfce4-wm + wm: x11-wm/xfce4-wm - xfdev: dev/xfce4-dev-tools + xfdev: dev/xfce4-dev-tools @@ -9826,10 +9858,10 @@ post-patch: USE_MYSQL - If the variable is set to yes, add - a dependency on the - databases/mysql55-client port. An - associated variable, + 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 values such as 323, 40, 41, 50, 51, 52, 55, or 60. @@ -9838,14 +9870,15 @@ post-patch: USE_PGSQL If set to yes, add dependency - on databases/postgresql90-client + on databases/postgresql90-client port. An associated variable, WANT_PGSQL_VER, may be set to values such as 83, 84, 90, 91 or 92. You can declare a minimum or maximum value; - WANT_PGSQL_VER= - 90+ will cause the - port to depend on a minimum version of 9.0. + WANT_PGSQL_VER= + 90+ will cause the port to depend on a + minimum version of 9.0. @@ -10967,7 +11000,8 @@ as .putsy.conf and edit it.. - Using <application>Subversion</application> to Make Patches + Using <application>Subversion</application> to Make + Patches When possible, please submit a &man.svn.1; diff. They are easier to handle than diffs between @@ -10992,9 +11026,9 @@ as .putsy.conf and edit it. svn0.us-west.FreeBSD.org - is a public Subversion server. Select the - closest mirror and verify the mirror server certificate - from the list of Subversion server. + Select the closest mirror and verify the mirror server + certificate from the list of Subversion mirror sites. @@ -11017,15 +11051,16 @@ as .putsy.conf and edit it. This will try to merge the differences between your - patch and current repository version; watch the output carefully. The - letter in front of each file name indicates what was done - with it. See for a - complete list. + patch and current repository version; watch the output + carefully. The letter in front of each file name + indicates what was done with it. See + for a complete list. - <application>Subversion</application> Update File Prefixes + <application>Subversion</application> Update File + Prefixes @@ -11058,12 +11093,12 @@ as .putsy.conf and edit it.If C is displayed as a result of svn update, it means something changed in - the Subversion repository and &man.svn.1; was not able to merge the - local changes with 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. + the Subversion repository and + &man.svn.1; was not able to merge the local changes with 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.The last step is to make a unified &man.diff.1; of the changes: @@ -11242,10 +11277,11 @@ as .putsy.conf and edit it.&os; 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 @@ -11257,20 +11293,20 @@ as .putsy.conf and edit it. A Short Introduction to VuXML - 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 - <tag> must have a matching closing </tag>. Tags - may be nested. If nesting, the inner tags must be closed - before the outer ones. There is a hierarchy of tags, i.e., - more complex rules of nesting them. This is similar to - HTML. The major difference is that XML is - eXtensible, i.e., based on defining - custom tags. Due to its intrinsic structure XML puts - otherwise amorphous data into shape. VuXML is particularly - tailored to mark up descriptions of security - vulnerabilities. + 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 <tag> must have a + matching closing </tag>. Tags may be nested. If + nesting, the inner tags must be closed before the outer + ones. There is a hierarchy of tags, i.e., more complex + rules of nesting them. This is similar to HTML. The major + difference is that XML is eXtensible, + i.e., based on defining custom tags. Due to its intrinsic + structure XML puts otherwise amorphous data into shape. + VuXML is particularly tailored to mark up descriptions of + security vulnerabilities. Now consider a realistic VuXML entry: @@ -11640,8 +11676,8 @@ Reference: <http://www.freebsd.org/po Introduction - Here is a list of common dos and don'ts that are encountered - during the porting process. Check the port + 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 @@ -11695,7 +11731,8 @@ Reference: <http://www.freebsd.org/po conditional compilation based upon what version of &os; Unix it is running under. The preferred way to tell &os; versions apart are the __FreeBSD_version and - __FreeBSD__ macros defined in sys/param.h. + __FreeBSD__ macros defined in sys/param.h. If this file is not included add the code, #include <sys/param.h>