Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 21 May 2013 15:24:27 -0400
From:      Tom Rhodes <trhodes@FreeBSD.org>
To:        Benjamin Kaduk <kaduk@MIT.EDU>
Cc:        svn-doc-projects@freebsd.org, trhodes@freebsd.org, doc-committers@freebsd.org
Subject:   Re: svn commit: r41663 - projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ports
Message-ID:  <20130521152427.25a28ecc.trhodes@FreeBSD.org>
In-Reply-To: <alpine.GSO.1.10.1305192327510.9389@multics.mit.edu>
References:  <201305181824.r4IIOBcm068566@svn.freebsd.org> <alpine.GSO.1.10.1305192327510.9389@multics.mit.edu>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, 19 May 2013 23:38:06 -0400 (EDT)
Benjamin Kaduk <kaduk@MIT.EDU> wrote:

> Apologies if I miss fixes in follow-up commits.
> 
> On Sat, 18 May 2013, Tom Rhodes wrote:
> 
> > Modified: projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ports/chapter.xml
> > ==============================================================================
> > --- projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ports/chapter.xml	Sat May 18 18:09:00 2013	(r41662)
> > +++ projects/ISBN_1-57176-407-0/en_US.ISO8859-1/books/handbook/ports/chapter.xml	Sat May 18 18:24:11 2013	(r41663)
> > @@ -1800,18 +1800,18 @@ ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/
> >
> >     <itemizedlist>
> >       <listitem>
> > -	<para>Use &man.pkg.info.1; to find out which files were
> > -	  installed, and where.  For example, if you have just
> > -	  installed FooPackage version 1.0.0, then this command</para>
> > +	<para>The &man.pkg.info.1; will print all installed
> 
> "The pkg_info(1)" is quite odd grammar, getting the worst of both worlds 
> between "the pkg_info(1) command" and just "pkg_info(1)".
> 
> > +	  files and their location.  For example, if the FooPackage
> > +	  version 1.0.0 was just installed, then the following
> > +	  command will show all the files installed with the
> > +	  package.</para>
> >
> > 	<screen>&prompt.root; <userinput>pkg_info -L <replaceable>foopackage-1.0.0</replaceable> | less</userinput></screen>
> >
> > -	<para>will show all the files installed by the package.  Pay
> > -	  special attention to files located in
> > -	  <filename>man/</filename>, which will be manual pages,
> > -	  <filename>etc/</filename>, which will be configuration
> > -	  files, and <filename>doc/</filename>, which will be more
> > -	  comprehensive documentation.</para>
> > +	<para>Configuration files are always installed in the
> > +	  <filename role="directory">/usr/local/etc</filename>
> 
> This "the" is spurious.
> 
> > +	  and should definitely be consulted before attempting
> > +	  to use the new application.</para>
> >
> > 	<para>To determine which version of the application was
> > 	  installed:</para>
> > @@ -1825,17 +1825,18 @@ ftp://ftp.FreeBSD.org/pub/FreeBSD/ports/
> >       </listitem>
> >
> >       <listitem>
> > -	<para>Once you have identified where the application's manual
> > -	  pages have been installed, review them using &man.man.1;.
> > -	  Review the sample configuration files and any additional
> > -	  documentation that may have been provided.</para>
> > +	<para>These commands will also show the names of any manual
> > +	  pages installed with the application.  This additional
> > +	  documentation will now be available to the &man.man.1;
> > +	  command.</para>
> >       </listitem>
> >
> >       <listitem>
> > -	<para>If the application has a web site, check it for
> > -	  additional documentation, frequently asked questions, and so
> > -	  forth.  If you are not sure of the web site address it may
> > -	  be listed in the output from</para>
> > +	<para>If the application has a web site, consult it for
> > +	  additional documentation, frequently asked questions, or
> > +	  a forum.  If the website is unknown, the following command
> 
> The comma usage here seems broken, as "a forum" is an alternative to "a 
> web site", and the only things bound to "a web site" are now "additional 
> documentation, frequently asked quesions", which should take "and" with no 
> comma and does not need to be followed by a comma.

I kind of disagree - forums can be separate or part of a main
site.  It really depends and I'm not going to debate how to word
it out proper - I've just removed forum.  Cheers,

--
Tom Rhodes






Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20130521152427.25a28ecc.trhodes>