From owner-svn-doc-all@FreeBSD.ORG Sat Dec 8 13:32:23 2012 Return-Path: Delivered-To: svn-doc-all@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id 41737A1B; Sat, 8 Dec 2012 13:32:23 +0000 (UTC) (envelope-from eadler@FreeBSD.org) Received: from svn.freebsd.org (svn.freebsd.org [IPv6:2001:1900:2254:2068::e6a:0]) by mx1.freebsd.org (Postfix) with ESMTP id 0A95F8FC08; Sat, 8 Dec 2012 13:32:23 +0000 (UTC) Received: from svn.freebsd.org (localhost [127.0.0.1]) by svn.freebsd.org (8.14.5/8.14.5) with ESMTP id qB8DWMFc046773; Sat, 8 Dec 2012 13:32:22 GMT (envelope-from eadler@svn.freebsd.org) Received: (from eadler@localhost) by svn.freebsd.org (8.14.5/8.14.5/Submit) id qB8DWMnV046772; Sat, 8 Dec 2012 13:32:22 GMT (envelope-from eadler@svn.freebsd.org) Message-Id: <201212081332.qB8DWMnV046772@svn.freebsd.org> From: Eitan Adler Date: Sat, 8 Dec 2012 13:32:22 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r40306 - 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.14 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: Sat, 08 Dec 2012 13:32:23 -0000 Author: eadler Date: Sat Dec 8 13:32:22 2012 New Revision: 40306 URL: http://svnweb.freebsd.org/changeset/doc/40306 Log: Wording tweaks to the pkg-descr section of the porter's handbook. Submitted by: wblock Approved by: bcr (mentor) 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 Sat Dec 8 00:09:39 2012 (r40305) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Sat Dec 8 13:32:22 2012 (r40306) @@ -185,18 +185,17 @@ USE_IMAKE= yes fonts). - Well-written description text should describe the port - completely enough that users would not have to consult its - documentation or visit its website to understand what does it - do, how it can be useful for them, what particularly nice - features (if any) does it have, etc. You might want to - mention certain requirements (e.g. the graphical toolkit), - heavy dependencies, runtime environment, or implementation - languages, to help users to decide if they want to install - this port or not. + A well-written pkg-descr describes + the port completely enough that users would not have to + consult the documentation or visit the website to understand + what the software does, how it can be useful, or what + particularly nice features it has. Mentioning certain + requirements like a graphical toolkit, heavy dependencies, + runtime environment, or implementation languages help users + whether this port will work for them. - If the ported software has an official WWW homepage, it - should be listed here. Prepend one of + Include a URL to the official WWW homepage. + Prepend 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