svn commit: r44808 - head/en_US.ISO8859-1/books/porters-handbook/makefiles

Rene Ladan rene at FreeBSD.org
Sun May 11 15:21:55 UTC 2014


Author: rene
Date: Sun May 11 15:21:54 2014
New Revision: 44808
URL: http://svnweb.freebsd.org/changeset/doc/44808

Log:
  Remove a section on WITH_ and WITHOUT_ knobs.  The text referred
  to ^/KNOBS in the Ports repository which has been removed for a while.
  
  The options framework should be used instead.
  
  Prodded by:	Barnerd on #bsddocs

Modified:
  head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml

Modified: head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Sat May 10 11:44:24 2014	(r44807)
+++ head/en_US.ISO8859-1/books/porters-handbook/makefiles/chapter.xml	Sun May 11 15:21:54 2014	(r44808)
@@ -3447,95 +3447,6 @@ MASTERDIR=	${.CURDIR}/../xdvi300
       options properly will make users happy, and effectively provide
       two or more ports for the price of one.</para>
 
-    <sect2 xml:id="makefile-knobs">
-      <title>Knobs</title>
-
-      <sect3 xml:id="makefile-knobs-with_">
-	<title><varname>WITH_<replaceable>*</replaceable></varname>
-	  and
-	  <varname>WITHOUT_<replaceable>*</replaceable></varname></title>
-
-	<para>These variables are designed to be set by the system
-	  administrator.  There are many that are standardized in the
-	  <link
-	    xlink:href="http://svnweb.FreeBSD.org/ports/head/KNOBS?view=markup"><filename>ports/KNOBS</filename></link>
-	  file.</para>
-
-	<para>When creating a port, do not make knob names specific to
-	  a given application.  For example in Avahi port, use
-	  <varname>WITHOUT_MDNS</varname> instead of
-	  <varname>WITHOUT_AVAHI_MDNS</varname>.</para>
-
-	<note>
-	  <para>You should not assume that a
-	    <varname>WITH_<replaceable>*</replaceable></varname>
-	    necessarily has a corresponding
-	    <varname>WITHOUT_<replaceable>*</replaceable></varname>
-	    variable and vice versa.  In general, the default is
-	    simply assumed.</para>
-	</note>
-
-	<note>
-	  <para>Unless otherwise specified, these variables are only
-	    tested for being set or not set, rather than being set to
-	    a specific value such as <literal>YES</literal> or
-	    <literal>NO</literal>.</para>
-	</note>
-
-	<table frame="none">
-	  <title>Common
-	    <varname>WITH_<replaceable>*</replaceable></varname> and
-	    <varname>WITHOUT_<replaceable>*</replaceable></varname>
-	    Variables</title>
-
-	  <tgroup cols="2">
-	    <thead>
-	      <row>
-		<entry>Variable</entry>
-		<entry>Means</entry>
-	      </row>
-	    </thead>
-
-	    <tbody>
-	      <row>
-		<entry><varname>WITH_OPENSSL_BASE</varname></entry>
-		<entry>Use the version of OpenSSL in the base
-		  system.</entry>
-	      </row>
-
-	      <row>
-		<entry><varname>WITH_OPENSSL_PORT</varname></entry>
-		<entry>Installs the version of OpenSSL from
-		  <package role="port">security/openssl</package>,
-		  even if the base is up to date.</entry>
-	      </row>
-	    </tbody>
-	  </tgroup>
-	</table>
-      </sect3>
-
-      <sect3 xml:id="makefile-knobs-naming">
-	<title>Knob Naming</title>
-
-	<para>Porters should use like-named knobs, both for the
-	  benefit of end-users and to help keep the number of knob
-	  names down.  A list of popular knob names can be found in
-	  the <link
-	    xlink:href="http://svnweb.FreeBSD.org/ports/head/KNOBS?view=markup"><filename>KNOBS</filename></link>
-	  file.</para>
-
-	<para>Knob names should reflect what the knob is and does.
-	  When a port has a lib-prefix in the
-	  <varname>PORTNAME</varname> the lib-prefix should be
-	  dropped in knob naming.</para>
-
-	<note>
-	  <para>Knob names should be always be in all
-	    uppercase.</para>
-	</note>
-      </sect3>
-    </sect2>
-
     <sect2 xml:id="makefile-options-options">
       <title><varname>OPTIONS</varname></title>
 


More information about the svn-doc-all mailing list