Patch for porter's handbook

Guido Falsi madpilot at FreeBSD.org
Sat Dec 8 22:28:06 UTC 2012


On 12/08/12 23:04, Eitan Adler wrote:
> On 8 December 2012 16:56, Guido Falsi <madpilot at freebsd.org> wrote:
>> On 12/08/12 22:22, Eitan Adler wrote:
>>>
>>> On 8 December 2012 16:19, Guido Falsi <madpilot at freebsd.org> wrote:
>>>>
>>>> Hi!
>>>> Some time ago the maintainer of net-mgmt/mrtg noticed that the porter's
>>>> handbook still reference NOPORTDOCS in place of the new DOCS option in
>>>> optionsng.
>>>>
>>>> I have a patch(attached) which fixes this. bapt has already seen it and
>>>> approved it, as suggested by him I added a tag around "DOCS".
>>>>
>>>> I'd like this patch to be revised by someone of the documentation team
>>>> and
>>>> approved for committing it. I'm obviously accepting any comment or
>>>> correction.
>>>
>>>
>>> The content changes look good. However, please don't make whitespace /
>>> formatting changes in the same patch as this makes it harder to figure
>>> out what changed for both the reviewers and translators.
>>>
>>
>> Good point. Here is a revised patch with only the content changes included.
>
> Looks good to me.
>
> Not your text but:
>
> "and neither would be added to port packing list" doesn't sound quite
> right.  Try replacing "and neither would be" with "or".
>

Done. final patch for approval attached.


-- 
Guido Falsi <madpilot at FreeBSD.org>
-------------- next part --------------
Index: en_US.ISO8859-1/books/porters-handbook/book.xml
===================================================================
--- en_US.ISO8859-1/books/porters-handbook/book.xml	(revision 40307)
+++ en_US.ISO8859-1/books/porters-handbook/book.xml	(working copy)
@@ -4922,11 +4922,11 @@
 	  <makevar>PKGNAME</makevar>.</para>
 
 	<para>Make the installation dependent on the variable
-	  <makevar>NOPORTDOCS</makevar> so that users can disable it
+	  <literal>DOCS</literal> option so that users can disable it
 	  in <filename>/etc/make.conf</filename>, like this:</para>
 
 	<programlisting>post-install:
-.if !defined(NOPORTDOCS)
+.if ${PORT_OPTIONS:MDOCS}
 	${MKDIR} ${DOCSDIR}
 	${INSTALL_MAN} ${WRKSRC}/docs/xvdocs.ps ${DOCSDIR}
 .endif</programlisting>
@@ -4968,13 +4968,13 @@
 	</itemizedlist>
 
 	<note>
-	  <para><makevar>NOPORTDOCS</makevar> only controls additional
+	  <para>The <literal>DOCS</literal> option only controls additional
 	    documentation installed in <makevar>DOCSDIR</makevar>.  It
 	    does not apply to standard man pages and info pages.
 	    Things installed in <makevar>DATADIR</makevar> and
 	    <makevar>EXAMPLESDIR</makevar> are controlled by
-	    <makevar>NOPORTDATA</makevar> and
-	    <makevar>NOPORTEXAMPLES</makevar>, respectively.</para>
+	    <literal>DATA</literal> and
+	    <literal>EXAMPLES</literal> options, respectively.</para>
 	</note>
 
 	<para>These variables are exported to
@@ -5008,10 +5008,10 @@
 	  is listed in <makevar>PORTDOCS</makevar> or matched by a
 	  glob pattern from this variable, the entire subtree of
 	  contained files and directories will be registered in the
-	  final packing list.  If <makevar>NOPORTDOCS</makevar> is
-	  defined then files and directories listed in
-	  <makevar>PORTDOCS</makevar> would not be installed and
-	  neither would be added to port packing list.  Installing the
+	  final packing list.  If the <literal>DOCS</literal> option has
+	  been unset then files and directories listed in
+	  <makevar>PORTDOCS</makevar> would not be installed
+	  or added to port packing list.  Installing the
 	  documentation at <makevar>PORTDOCS</makevar> as shown above
 	  remains up to the port itself.  A typical example of
 	  utilizing <makevar>PORTDOCS</makevar> looks as


More information about the freebsd-doc mailing list