Ticket #25189: describe_supported_archs.diff

guide/xml/portfile-keywords.xml

@@ -191 +191 @@
         <programlisting>platforms           darwin freebsd</programlisting>
       </listitem>
     </varlistentry>
+
+    <varlistentry>
+      <term>supported_archs</term>
+
+      <listitem>
+        <para>The architecture the port can be built for.</para>
+
+        <para>Its value will be used to define the <code>configure.build_arch</code>
+        and <code>configure.universal_archs</code> variables.</para>
+        
+        <para>Supported values are : <code>noarch</code> or any combination of 
+        <code>ppc</code>, <code>ppc64</code>, <code>i386</code>, <code>x86_64</code>.
+        <code>noarch</code> is used to indicate that the port is architecture independent
+        (eg. a java program).</para>
+        
+        <para>If the building architecture isn't among <code>supported_archs</code>,
+        port fails with an error message except when building on <code>x86_64</code>
+        (resp. <code>ppc64</code>) and <code>supported_archs</code> contains
+        <code>i386</code> (resp. <code>ppc</code>). In this case, the port will be built
+        in 32 bit mode.</para>
+        
+        <para>One should use <code>supported_archs</code> instead of hard-coding
+        <code>configure.build_arch</code> or <code>configure.universal_archs</code>
+        in the Portfile, eg. when a programs uses the Carbon API and
+        hence wont build in 64 bit mode.</para>
+        
+        <programlisting>supported_archs           ppc i386</programlisting>
+      </listitem>
+    </varlistentry>
   </variablelist>
 </section>