From owner-svn-doc-head@FreeBSD.ORG Mon Dec 10 02:06:28 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 A2BDFC2 for ; Mon, 10 Dec 2012 02:06:28 +0000 (UTC) (envelope-from lists@eitanadler.com) Received: from mail-la0-f54.google.com (mail-la0-f54.google.com [209.85.215.54]) by mx1.freebsd.org (Postfix) with ESMTP id 0DF5F8FC0C for ; Mon, 10 Dec 2012 02:06:27 +0000 (UTC) Received: by mail-la0-f54.google.com with SMTP id j13so2033763lah.13 for ; Sun, 09 Dec 2012 18:06:26 -0800 (PST) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=eitanadler.com; s=0xdeadbeef; h=mime-version:sender:in-reply-to:references:from:date :x-google-sender-auth:message-id:subject:to:cc:content-type; bh=cxzm0ShstynuSUBWgE5Uk/DqwqKlDDT5sI0VmFo/euo=; b=VVcnJ/WpMZAzAqCOLtIQe6/R1+DQ4zTUX+lPP2Q4D5NMocg/uR4ki9R8Ika/xpIR6g /kGEJhkLpj9RRkjYapg9apHNwQCleyWnYn66dqOOb/RT5ogNJ+iYhsHPvzt8UGksWSQT PRcsyWvgY6YQYdlRvsOf4uGCQXpwMCdbiAFWI= X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20120113; h=mime-version:sender:in-reply-to:references:from:date :x-google-sender-auth:message-id:subject:to:cc:content-type :x-gm-message-state; bh=cxzm0ShstynuSUBWgE5Uk/DqwqKlDDT5sI0VmFo/euo=; b=cgYfT+7BM8XPWNkiYoRwLaehAY0+rIRqeZ7lIBnrqyXZb3kxxwtO6oWeAWr8jIb1X6 FdTlJloIr+A7zwLVnAgaLFwmyz5HF4h8GTAKBtTZZKhYrfR3rJOemRw9bfso0hDFSsiT wgG8XQL+L7rTT2gxx/2UHXjOFcuRKBvf9AdzULQZ81QO+ANTgaZXFPVrAvakEw3pRbtH LQK4XjUqvwwBLQCJXhic7eqmlpQbOpZQ1V7/WJejD8roiokqdwHaheikbeM2buynK1CG eL/BFeOHCXCPpYRhXeUh0B7GceC9ZxhuPeWqeApBTUaB0ybHtSGFRWSCW173qy7FuZPo 0ubQ== Received: by 10.152.105.103 with SMTP id gl7mr12109346lab.10.1355105186228; Sun, 09 Dec 2012 18:06:26 -0800 (PST) MIME-Version: 1.0 Sender: lists@eitanadler.com Received: by 10.112.43.229 with HTTP; Sun, 9 Dec 2012 18:05:56 -0800 (PST) In-Reply-To: References: <201212081332.qB8DWMnV046772@svn.freebsd.org> From: Eitan Adler Date: Sun, 9 Dec 2012 21:05:56 -0500 X-Google-Sender-Auth: DWYZ6J7sVjJ-ZerUDSQ1tDNEuSU Message-ID: Subject: Re: svn commit: r40306 - head/en_US.ISO8859-1/books/porters-handbook To: Benjamin Kaduk Content-Type: text/plain; charset=UTF-8 X-Gm-Message-State: ALoCoQlFZBX/ddNzobPTGnQm7agJPwPVlmEwJ+S7/24PD59nleFRmPGAwn8qThQcHS8EXzn36Vfz 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:06:28 -0000 On 9 December 2012 20:56, Benjamin Kaduk wrote: > 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). Will fix - thanks. -- Eitan Adler Source, Ports, Doc committer Bugmeister, Ports Security teams