[patch] en/handbook/ports: another small cleanup

Warren Block wblock at wonkity.com
Fri Apr 12 00:02:24 UTC 2013


On Thu, 11 Apr 2013, Taras Korenko wrote:

>  Hi, folks.
>
>  Could anyone of doc@ review/comment/approve the following small changes
> to en/books/handbook/ports ?
>
>
>  1) An obvious chunk:
> ----------------------------------------------------------------------------
> Index: en_US.ISO8859-1/books/handbook/ports/chapter.xml
> ===================================================================
> --- en_US.ISO8859-1/books/handbook/ports/chapter.xml	(revision 41406)
> +++ en_US.ISO8859-1/books/handbook/ports/chapter.xml	(working copy)
> @@ -116,7 +116,7 @@
>       commands.</para>
>
>     <para>Both packages and ports understand
> -      <emphasis>dependencies</emphasis>. If &man.pkg.add.1; or the
> +      <emphasis>dependencies</emphasis>.  If &man.pkg.add.1; or the
>       Ports Collection is used to install an application and a
>       dependent library is not already installed, the library will
>       automatically be installed first.</para>
> @@ -1337,7 +1337,7 @@
>
>       <para>Once the compile is complete, you are returned to the
> 	prompt.  The next step is to install the port using
> -	<maketarget>make install</maketarget>:</para>
> +	<command>make <maketarget>install</maketarget></command>:</para>

Agreed on the command tags, but I'm not sure the maketarget tags are 
needed there.  Can't say they should not be there either, though.

>       <screen>&prompt.root; <userinput>make install</userinput>
> ===>  Installing for lsof-4.57
> @@ -1670,22 +1670,22 @@
> 	<itemizedlist>
> 	  <listitem>
> 	    <para>Root ports: no dependencies and is not depended on
> -	      by other ports</para>
> +	      by other ports;</para>
> 	  </listitem>
>
> 	  <listitem>
> 	    <para>Trunk ports: no dependencies, but other ports depend
> -	      upon it</para>
> +	      upon it;</para>
> 	  </listitem>
>
> 	  <listitem>
> 	    <para>Branch ports: have dependencies and are depended
> -	      upon by other ports</para>
> +	      upon by other ports;</para>
> 	  </listitem>
>
> 	  <listitem>
> 	    <para>Leaf ports: have dependencies but are not depended
> -	      upon by other ports</para>
> +	      upon by other ports.</para>
> 	  </listitem>
> 	</itemizedlist>

Adding those semicolons and the period makes those entries into a long 
sentence, or tries.  But they are already in a list, so this seems 
unnecessary.  Besides, semicolons are kind of weakly evil.  Using them 
as a supercomma is not so bad, but still...  Also, they may have to be 
entered as ;.  Or maybe not, I've lost track.

> ----------------------------------------------------------------------------
>
>
>  2) A controversial one:
> ----------------------------------------------------------------------------
> Index: en_US.ISO8859-1/books/handbook/ports/chapter.xml
> ===================================================================
> --- en_US.ISO8859-1/books/handbook/ports/chapter.xml	(revision 41406)
> +++ en_US.ISO8859-1/books/handbook/ports/chapter.xml	(working copy)
> @@ -1778,7 +1778,8 @@
>
>       <note>
> 	<para>The <command>portsclean</command> utility is part of the
> -	  <application>portupgrade</application> suite.</para>
> +	  <filename role="package">ports-mgmt/portupgrade</filename>
> +	  suite.</para>
>       </note>

Seems okay to me.


More information about the freebsd-doc mailing list