From owner-svn-doc-head@FreeBSD.ORG Sun Jan 12 20:13:18 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 B190B9B1; Sun, 12 Jan 2014 20:13:18 +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 91EAF1DEF; Sun, 12 Jan 2014 20:13:18 +0000 (UTC) Received: from svn.freebsd.org ([127.0.1.70]) by svn.freebsd.org (8.14.7/8.14.7) with ESMTP id s0CKDI2E092145; Sun, 12 Jan 2014 20:13:18 GMT (envelope-from wblock@svn.freebsd.org) Received: (from wblock@localhost) by svn.freebsd.org (8.14.7/8.14.7/Submit) id s0CKDIsT092144; Sun, 12 Jan 2014 20:13:18 GMT (envelope-from wblock@svn.freebsd.org) Message-Id: <201401122013.s0CKDIsT092144@svn.freebsd.org> From: Warren Block Date: Sun, 12 Jan 2014 20:13:18 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r43481 - 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-head@freebsd.org X-Mailman-Version: 2.1.17 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: Sun, 12 Jan 2014 20:13:18 -0000 Author: wblock Date: Sun Jan 12 20:13:18 2014 New Revision: 43481 URL: http://svnweb.freebsd.org/changeset/doc/43481 Log: Clarify and simplify the Submitting the New Port section. Remove redundant wording, break up into more paragraphs, use send-pr field names consistently, remove unnecessary informal use of "you". 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 19:43:30 2014 (r43480) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Sun Jan 12 20:13:18 2014 (r43481) @@ -447,43 +447,43 @@ PLIST_DIRS= lib/X11/oneko Submitting the New Port - Before you submit the new port, make sure you have read + Before submitting the new port, read the DOs and DON'Ts section. - Now that you are happy with your port, the only thing + 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 your + everybody else happy about it too. We do not need the work directory or the - pkgname.tgz package, so delete them now. - Next, assuming your port is called oneko, + 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 - the following: + oneko directory is located, and then type: shar `find oneko` > oneko.shar - Include your oneko.shar file in a bug - report and send it with the &man.send-pr.1; program (see + Include oneko.shar in a bug + report and send it with &man.send-pr.1;. See Bug Reports and General Commentary for more information - about &man.send-pr.1;). Be sure to classify the bug report - as category ports and class - change-request (Do not mark the report - confidential!). Also add a short - description of the program you ported to the - Description field of the PR (e.g., perhaps a + 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. + the .shar file to the Fix field. - You can make our work a lot easier, if you use a good - description in the synopsis of the problem report. 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. If you stick to this - scheme, the chance that someone will take a look at your PR - soon is much better. + the port> for new ports. Using this + scheme makes it easier and faster to begin the work of committing + the new port. One more time, do not include the original @@ -492,14 +492,13 @@ PLIST_DIRS= lib/X11/onekomake package; and, do use &man.shar.1; for new ports, not &man.diff.1;. - After you have submitted your port, please be patient. - Sometimes it can take a few months before a port is included - in &os;, although it might only take a few days. You can - view the list of ports - PRs waiting to be committed to &os;. + 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 . - Once we have looked at your port, we will get back to you + 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