From owner-svn-doc-all@FreeBSD.ORG Wed Sep 10 13:14:00 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 741DF3A3; Wed, 10 Sep 2014 13:14:00 +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 5DE8710BA; Wed, 10 Sep 2014 13:14:00 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.9/8.14.9) with ESMTP id s8ADE0hX054062; Wed, 10 Sep 2014 13:14:00 GMT (envelope-from mat@FreeBSD.org) Received: (from mat@localhost) by svn.freebsd.org (8.14.9/8.14.9/Submit) id s8ADE0IJ054059; Wed, 10 Sep 2014 13:14:00 GMT (envelope-from mat@FreeBSD.org) Message-Id: <201409101314.s8ADE0IJ054059@svn.freebsd.org> X-Authentication-Warning: svn.freebsd.org: mat set sender to mat@FreeBSD.org using -f From: Mathieu Arnold Date: Wed, 10 Sep 2014 13:14:00 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r45586 - head/en_US.ISO8859-1/books/porters-handbook/quick-porting 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.18-1 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: Wed, 10 Sep 2014 13:14:00 -0000 Author: mat (ports committer) Date: Wed Sep 10 13:13:59 2014 New Revision: 45586 URL: http://svnweb.freebsd.org/changeset/doc/45586 Log: igor -Ry and some other rewording and fixes. Differential Revision: https://reviews.freebsd.org/D650 Reviewed by: wblock Sponsored by: Absolight Modified: head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml 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 Wed Sep 10 12:56:21 2014 (r45585) +++ head/en_US.ISO8859-1/books/porters-handbook/quick-porting/chapter.xml Wed Sep 10 13:13:59 2014 (r45586) @@ -20,7 +20,7 @@ /usr/ports/distfiles. - The following steps assume that the software compiled + These 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 This is not a manual or an in-depth description on how to use or compile the port! Please be careful when copying from the - README or manpage; too + README or manpage. Too often they are not a concise description of the port or - are in an awkward format (e.g., manpages have justified - spacing, which looks particularly bad with monospaced - fonts). + are in an awkward format. For example, manpages have + justified spacing, which looks particularly bad with + monospaced fonts. A well-written pkg-descr describes @@ -116,7 +116,7 @@ COMMENT= Cat chasing a mouse all over th one of the websites (pick the most common one) with WWW: (followed by single space) so that automated tools will work correctly. If the - URI is the root of the website or directory, it should be + URI is the root of the website or directory, it must be terminated with a slash. @@ -125,8 +125,8 @@ COMMENT= Cat chasing a mouse all over th moved, was renamed, or is hosted elsewhere. - The following example shows how the - pkg-descr should look: + This example shows how + pkg-descr looks: This is a port of oneko, in which a cat chases a poor mouse all over the screen. @@ -182,8 +182,8 @@ lib/X11/oneko/mouse.xpm PLIST_DIRS, respectively, within the port's Makefile. For instance, we could get along without pkg-plist in - the above oneko port by adding the - following lines to the Makefile: + the above oneko port by adding these + lines to the Makefile: PLIST_FILES= bin/oneko \ man/man1/oneko.1.gz \ @@ -193,12 +193,12 @@ lib/X11/oneko/mouse.xpm lib/X11/oneko/mouse.xpm PLIST_DIRS= lib/X11/oneko - Of course, PLIST_DIRS should be left - unset if a port installs no directories of its own. + Of course, PLIST_DIRS does not need to + be set if a port installs no directories of its own. Several ports can share a common directory. In that - case, PLIST_DIRS should be replaced by + case, PLIST_DIRS must be replaced by PLIST_DIRSTRY so that the directory is removed only if empty, otherwise it is silently ignored. PLIST_DIRS and @@ -351,26 +351,30 @@ PLIST_DIRS= lib/X11/onekoshar `find oneko` > oneko.shar + - Classify the bug report as Category - ports and Class - change-request. Do not - mark the report confidential! Add a short + To submit oneko.shar, use the bug submit + form (category Ports Tree). + 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. + (perhaps a short version of COMMENT), and + don't forget to add oneko.shar as an + attachment. - Giving a good description in the synopsis of the problem + Giving a good description in the summary 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 + 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. @@ -388,7 +392,7 @@ PLIST_DIRS= lib/X11/oneko. 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 + and commit it to the tree. The submitter's name will also be added to the list of Additional &os; Contributors and other files.