[33664] trunk/doc-new/guide/xml/portfile-variants.xml

[markd at macports.org]

Revision: 33664
          http://trac.macosforge.org/projects/macports/changeset/33664
Author:   markd at macports.org
Date:     2008-02-02 12:18:42 -0800 (Sat, 02 Feb 2008)

Log Message:
-----------
Clarify and corrections.  Also incorporate ryan's suggestion in #14141.

Modified Paths:
--------------
    trunk/doc-new/guide/xml/portfile-variants.xml

Modified: trunk/doc-new/guide/xml/portfile-variants.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-variants.xml	2008-02-02 19:38:02 UTC (rev 33663)
+++ trunk/doc-new/guide/xml/portfile-variants.xml	2008-02-02 20:18:42 UTC (rev 33664)
@@ -14,12 +14,20 @@
   <section id="reference.variants.user-selected">
     <title>User-Selected Variants</title>
 
-    <para>User-selected variants are those that are defined so that a user or
-    port author can use them at their discretion.</para>
+    <para>User-selected variants are those that are defined so a user can
+    invoke them to enable port options at install time. They also allow a port
+    author a level of modularity and control using the keyword
+    <code>default_variants</code> (see below).</para>
 
+    <note>
+      <para>Variant names must not contain hyphens. For example, use
+      <code>no_x11</code> rather than <code>no-x11</code>.</para>
+    </note>
+
     <variablelist>
       <varlistentry>
-        <term>variant [requires <replaceable>variant</replaceable>] [conflicts
+        <term>variant <replaceable>name</replaceable> [requires
+        <replaceable>variant</replaceable>] [conflicts
         <replaceable>variant</replaceable>] [description
         <replaceable>description</replaceable>]</term>
 
@@ -123,12 +131,13 @@
     <title>Platform Variants</title>
 
     <para>Platform variants are either defined by default in MacPorts base, or
-    defined by a port author port installation customization by OS or hardware
-    platform.</para>
+    defined by a port author to customize a port's installation according to
+    OS (operating system) or hardware platform.</para>
 
     <variablelist>
       <varlistentry>
-        <term>platform <replaceable>platform</replaceable>
+        <term>platform [<replaceable>os_platform</replaceable>]
+        [<replaceable>hw_platform</replaceable>]
         [<replaceable>version</replaceable>]
         [<replaceable>arch</replaceable>]</term>
 

-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20080202/87116eff/attachment.html