svn commit: r50295 - head/en_US.ISO8859-1/books/porters-handbook/porting-samplem

[Mathieu Arnold]

Author: mat
Date: Tue May 30 16:35:25 2017
New Revision: 50295
URL: https://svnweb.freebsd.org/changeset/doc/50295

Log:
  Add the BROKEN/IGNORE/DEPRECATED block.
  
  Sponsored by:	Absolight

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

Modified: head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml
==============================================================================
--- head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml	Tue May 30 01:19:35 2017	(r50294)
+++ head/en_US.ISO8859-1/books/porters-handbook/porting-samplem/chapter.xml	Tue May 30 16:35:25 2017	(r50295)
@@ -343,6 +343,78 @@ pre-install:
 	variables by license name.</para>
     </sect2>
 
+    <sect2 xml:id="porting-samplem-broken">
+      <title>Generic
+	<varname>BROKEN</varname>/<varname>IGNORE</varname>/<varname>DEPRECATED</varname>
+	Messages</title>
+
+      <para>This block is optional.  The variables are:</para>
+
+      <itemizedlist>
+	<listitem>
+	  <para><link
+	      linkend="dads-deprecated">DEPRECATED</link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link
+	      linkend="dads-deprecated">EXPIRATION_DATE</link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">FORBIDDEN</link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">BROKEN</link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">BROKEN_<replaceable>*</replaceable></link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">IGNORE</link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">IGNORE_<replaceable>*</replaceable></link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">ONLY_FOR_ARCHS</link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">ONLY_FOR_ARCHS_REASON<replaceable>*</replaceable></link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">NOT_FOR_ARCHS</link></para>
+	</listitem>
+
+	<listitem>
+	  <para><link linkend="dads-noinstall">NOT_FOR_ARCHS_REASON<replaceable>*</replaceable></link></para>
+	</listitem>
+      </itemizedlist>
+
+      <note>
+	<para><varname>BROKEN<replaceable>*</replaceable></varname>
+	  and <varname>IGNORE<replaceable>*</replaceable></varname>
+	  can be any generic variables, for example,
+	  <varname>IGNORE_amd64</varname>,
+	  <varname>BROKEN_FreeBSD_10</varname>,
+	  <varname>BROKEN_SSL</varname>, etc.</para>
+
+	<para>If the port is marked BROKEN when some conditions are
+	  met, and such conditions can only be tested after including
+	  <filename>bsd.port.options.mk</filename> or
+	  <filename>bsd.port.pre.mk</filename>, then those variables
+	  should be set later, in <xref
+	    linkend="porting-samplem-rest"/>.</para>
+      </note>
+    </sect2>
+
     <sect2 xml:id="porting-samplem-depends">
       <title>The Dependencies Block</title>