Changeset 33664 for trunk/doc-new


Ignore:
Timestamp:
Feb 2, 2008, 8:18:42 PM (12 years ago)
Author:
markd@…
Message:

Clarify and corrections. Also incorporate ryan's suggestion in #14141.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc-new/guide/xml/portfile-variants.xml

    r32903 r33664  
    1515    <title>User-Selected Variants</title>
    1616
    17     <para>User-selected variants are those that are defined so that a user or
    18     port author can use them at their discretion.</para>
     17    <para>User-selected variants are those that are defined so a user can
     18    invoke them to enable port options at install time. They also allow a port
     19    author a level of modularity and control using the keyword
     20    <code>default_variants</code> (see below).</para>
     21
     22    <note>
     23      <para>Variant names must not contain hyphens. For example, use
     24      <code>no_x11</code> rather than <code>no-x11</code>.</para>
     25    </note>
    1926
    2027    <variablelist>
    2128      <varlistentry>
    22         <term>variant [requires <replaceable>variant</replaceable>] [conflicts
     29        <term>variant <replaceable>name</replaceable> [requires
     30        <replaceable>variant</replaceable>] [conflicts
    2331        <replaceable>variant</replaceable>] [description
    2432        <replaceable>description</replaceable>]</term>
     
    124132
    125133    <para>Platform variants are either defined by default in MacPorts base, or
    126     defined by a port author port installation customization by OS or hardware
    127     platform.</para>
     134    defined by a port author to customize a port's installation according to
     135    OS (operating system) or hardware platform.</para>
    128136
    129137    <variablelist>
    130138      <varlistentry>
    131         <term>platform <replaceable>platform</replaceable>
     139        <term>platform [<replaceable>os_platform</replaceable>]
     140        [<replaceable>hw_platform</replaceable>]
    132141        [<replaceable>version</replaceable>]
    133142        [<replaceable>arch</replaceable>]</term>
Note: See TracChangeset for help on using the changeset viewer.