Date: Sun, 9 Dec 2012 21:05:56 -0500 From: Eitan Adler <eadler@freebsd.org> To: Benjamin Kaduk <kaduk@mit.edu> Cc: svn-doc-head@freebsd.org, svn-doc-all@freebsd.org, doc-committers@freebsd.org Subject: Re: svn commit: r40306 - head/en_US.ISO8859-1/books/porters-handbook Message-ID: <CAF6rxgmonuecyrRE0WLnJ99w6=-ySWp55%2BRbS1bYJxdWMy8JmQ@mail.gmail.com> In-Reply-To: <alpine.GSO.1.10.1212092055090.2164@multics.mit.edu> References: <201212081332.qB8DWMnV046772@svn.freebsd.org> <alpine.GSO.1.10.1212092055090.2164@multics.mit.edu>
next in thread | previous in thread | raw e-mail | index | archive | help
On 9 December 2012 20:56, Benjamin Kaduk <kaduk@mit.edu> 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).</para> >> </note> >> >> - <para>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.</para> >> + <para>A well-written <filename>pkg-descr</filename> 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.</para> > > > 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
Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?CAF6rxgmonuecyrRE0WLnJ99w6=-ySWp55%2BRbS1bYJxdWMy8JmQ>