Patch for porter's handbook

Guido Falsi madpilot at FreeBSD.org
Sat Dec 8 21:19:39 UTC 2012


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.

Please note that I'm not subscribed to docs@, so please reply also 
directly to me.

Thanks in advance!

-- 
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 40306)
+++ en_US.ISO8859-1/books/porters-handbook/book.xml	(working copy)
@@ -4921,12 +4921,12 @@
 	  the same time, you can use the whole
 	  <makevar>PKGNAME</makevar>.</para>
 
-	<para>Make the installation dependent on the variable
-	  <makevar>NOPORTDOCS</makevar> so that users can disable it
+	<para>Make the installation dependent on the
+          <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
-	    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>
+	  <para>The <literal>DOCS</literal> options 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
+	  <literal>DATA</literal> and <literal>EXAMPLES</literal>
+	  options, respectively.</para>
 	</note>
 
 	<para>These variables are exported to
@@ -4997,25 +4997,24 @@
 %%PORTDOCS%%%%DOCSDIR%%/CONTACT
 %%PORTDOCS%%@dirrm %%DOCSDIR%%</programlisting>
 
-	<para>As an alternative to enumerating the documentation files
-	  in <filename>pkg-plist</filename>, a port can set the
-	  variable <makevar>PORTDOCS</makevar> to a list of file names
-	  and shell glob patterns to add to the final packing list.
-	  The names will be relative to <makevar>DOCSDIR</makevar>.
-	  Therefore, a port that utilizes <makevar>PORTDOCS</makevar>
-	  and uses a non-default location for its documentation should
-	  set <makevar>DOCSDIR</makevar> accordingly.  If a directory
-	  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
-	  documentation at <makevar>PORTDOCS</makevar> as shown above
-	  remains up to the port itself.  A typical example of
-	  utilizing <makevar>PORTDOCS</makevar> looks as
-	  follows:</para>
+	<para>As an alternative to enumerating the documentation
+	files in <filename>pkg-plist</filename>, a port can set the
+	variable <makevar>PORTDOCS</makevar> to a list of file names
+	and shell glob patterns to add to the final packing list.
+	The names will be relative to <makevar>DOCSDIR</makevar>.
+	Therefore, a port that utilizes <makevar>PORTDOCS</makevar>
+	and uses a non-default location for its documentation should
+	set <makevar>DOCSDIR</makevar> accordingly.  If a directory
+	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 <literal>DOCS</literal> option has
+	beeen unset then files and directories listed in
+	<makevar>PORTDOCS</makevar> would not be installed and
+	neither would be 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 follows:</para>
 
 	<programlisting>PORTDOCS=	README.* ChangeLog docs/*</programlisting>
 


More information about the freebsd-doc mailing list