From owner-svn-doc-all@FreeBSD.ORG Fri Dec 7 13:00:51 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 A78475C0; Fri, 7 Dec 2012 13:00:49 +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 B31CF8FC14; Fri, 7 Dec 2012 13:00:49 +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 qB7D0n8A098981; Fri, 7 Dec 2012 13:00:49 GMT (envelope-from eadler@svn.freebsd.org) Received: (from eadler@localhost) by svn.freebsd.org (8.14.5/8.14.5/Submit) id qB7D0nRe098980; Fri, 7 Dec 2012 13:00:49 GMT (envelope-from eadler@svn.freebsd.org) Message-Id: <201212071300.qB7D0nRe098980@svn.freebsd.org> From: Eitan Adler Date: Fri, 7 Dec 2012 13:00:49 +0000 (UTC) To: doc-committers@freebsd.org, svn-doc-all@freebsd.org, svn-doc-head@freebsd.org Subject: svn commit: r40293 - 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: Fri, 07 Dec 2012 13:00:51 -0000 Author: eadler Date: Fri Dec 7 13:00:49 2012 New Revision: 40293 URL: http://svnweb.freebsd.org/changeset/doc/40293 Log: Update and expand on the pkg-descr explanation in the porter's handbook. Submitted by: danfe 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 Fri Dec 7 13:00:46 2012 (r40292) +++ head/en_US.ISO8859-1/books/porters-handbook/book.xml Fri Dec 7 13:00:49 2012 (r40293) @@ -181,11 +181,32 @@ USE_IMAKE= yes 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). If the ported software has an official WWW - homepage, you should list it here. Prefix - one of the websites with - WWW: so that automated tools will work - correctly. + spacing, as it looks particularly bad with monospaced + 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. + + If the ported software has an official WWW homepage, it + should be listed here. 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 + of the website or directory, it should be terminated with a + slash. + + + If the listed webpage for a port is not available, try + to search the Internet first to see if the official site + moved, was renamed, or is hosted elsewhere. The following example shows how your