From owner-svn-doc-head@FreeBSD.ORG Mon Dec 10 02:01:51 2012 Return-Path: Delivered-To: svn-doc-head@freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [69.147.83.52]) by hub.freebsd.org (Postfix) with ESMTP id F22E3F6C; Mon, 10 Dec 2012 02:01:50 +0000 (UTC) (envelope-from kaduk@mit.edu) Received: from dmz-mailsec-scanner-2.mit.edu (DMZ-MAILSEC-SCANNER-2.MIT.EDU [18.9.25.13]) by mx1.freebsd.org (Postfix) with ESMTP id 4FE338FC0C; Mon, 10 Dec 2012 02:01:49 +0000 (UTC) X-AuditID: 1209190d-b7f266d00000092b-9d-50c5415b6935 Received: from mailhub-auth-2.mit.edu ( [18.7.62.36]) by dmz-mailsec-scanner-2.mit.edu (Symantec Messaging Gateway) with SMTP id FC.CF.02347.B5145C05; Sun, 9 Dec 2012 20:56:43 -0500 (EST) Received: from outgoing.mit.edu (OUTGOING-AUTH.MIT.EDU [18.7.22.103]) by mailhub-auth-2.mit.edu (8.13.8/8.9.2) with ESMTP id qBA1uh2s031947; Sun, 9 Dec 2012 20:56:43 -0500 Received: from multics.mit.edu (SYSTEM-LOW-SIPB.MIT.EDU [18.187.2.37]) (authenticated bits=56) (User authenticated as kaduk@ATHENA.MIT.EDU) by outgoing.mit.edu (8.13.6/8.12.4) with ESMTP id qBA1ueLx021376 (version=TLSv1/SSLv3 cipher=DHE-RSA-AES256-SHA bits=256 verify=NOT); Sun, 9 Dec 2012 20:56:42 -0500 (EST) Received: (from kaduk@localhost) by multics.mit.edu (8.12.9.20060308) id qBA1udIb013897; Sun, 9 Dec 2012 20:56:39 -0500 (EST) Date: Sun, 9 Dec 2012 20:56:39 -0500 (EST) From: Benjamin Kaduk To: Eitan Adler Subject: Re: svn commit: r40306 - head/en_US.ISO8859-1/books/porters-handbook In-Reply-To: <201212081332.qB8DWMnV046772@svn.freebsd.org> Message-ID: References: <201212081332.qB8DWMnV046772@svn.freebsd.org> User-Agent: Alpine 1.10 (GSO 962 2008-03-14) MIME-Version: 1.0 Content-Type: TEXT/PLAIN; charset=US-ASCII; format=flowed X-Brightmail-Tracker: H4sIAAAAAAAAA+NgFvrAIsWRmVeSWpSXmKPExsUixG6nohvteDTAYPM2IYsfHw8xWez6O4fZ 4sai/UwWu/t7mR1YPGZ8ms8SwBjFZZOSmpNZllqkb5fAlXFluWjBbIGKGwsWsjUw9vN2MXJy SAiYSDzZcIkdwhaTuHBvPVsXIxeHkMA+RomuR3NZIZz1jBLN024zQTjHmSTO/O5hBWkREqiX 2N00HcxmEdCSOLr4BzOIzSagIjHzzUY2EFsEyP6+/ycTiM0sECWxZ2kjUD0Hh7CAv0TfRAOQ MKeAlcTvhW1gJbwCDhJT+7ayQIy3lGg+ex1sjKiAjsTq/VNYIGoEJU7OfMICMdJS4tyf62wT GAVnIUnNQpJawMi0ilE2JbdKNzcxM6c4NVm3ODkxLy+1SNdILzezRC81pXQTIyhgOSV5dzC+ O6h0iFGAg1GJh3eBzNEAIdbEsuLK3EOMkhxMSqK8/vZAIb6k/JTKjMTijPii0pzU4kOMEhzM SiK8XMeOBAjxpiRWVqUW5cOkpDlYlMR5r6Tc9BcSSE8sSc1OTS1ILYLJynBwKEnwKjkADRUs Sk1PrUjLzClBSDNxcIIM5wEargxSw1tckJhbnJkOkT/FqCglzvsY5CIBkERGaR5cLyyhvGIU B3pFmPc3SBUPMBnBdb8CGswENPik4GGQwSWJCCmpBkYDQZngpevXn2rsfKQzp6PbcFdH1+Oo bN5dHFKzF22RuCPaufHWHnnuj5paupYq6477myev8656Vs2z12OSN9fVbSycPS2esWLnSqqU O//Lyf0Xlnk0+Tz34d9/jrZzd9m7384L42sQjdZV0Qp81C8dHi8tf7f75ubCjsUrX2yTvN/u JWWQpcRSnJFoqMVcVJwIAN1JKjoDAwAA Cc: svn-doc-head@freebsd.org, svn-doc-all@freebsd.org, doc-committers@freebsd.org X-BeenThere: svn-doc-head@freebsd.org X-Mailman-Version: 2.1.14 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: Mon, 10 Dec 2012 02:01:51 -0000 On Sat, 8 Dec 2012, Eitan Adler wrote: > 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. Presumably such knowledge will help users *decide* whether this port will work for them (as opposed to helping them whether or not the port will work for them, which is I guess also true). -Ben Kaduk