Changeset 3093 for trunk/doc


Ignore:
Timestamp:
Jul 30, 2003, 2:35:39 PM (16 years ago)
Author:
fkr
Message:

Bug: #721
Submitted by: wb@… (Will Barton)
Reviewed by:
Approved by:
Obtained from:

This patch makes a few corrections to the mirror site list documentation I submitted a few days
ago, based on suggestions made by Dr. Ernie. (1) Be a bit more specific about the nature of the
various tokens in the example in Chapter 2, and (2) Be a bit more specific about
master_sites.mirror_subdir in the example in Chapter 2.

Location:
trunk/doc/guide/xml
Files:
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/guide/xml/details.xml

    r3070 r3093  
    1818       
    1919                <para>All key value pairs in a Portfile are single lines so line breaks
    20                 must be escaped with a back solidus '\'. </para>
     20                must be escaped with a back slash ('\'). </para>
    2121                <para>Variables syntax is ${foo} for the foo variant.</para>
    2222        <sect2>
     
    2525                        "special". These have a special meaning in TCL and if you dont
    2626                        want that special meaning, they must be escaped. In general a
    27                         charachter is escaped using the back solidus '\'. The main
     27                        character is escaped using the back slash ('\'). The main
    2828                        characters you need to be careful with are
    2929                        <simplelist type="inline">
     
    362362               http://www.somemirror.org/somesite_org/files/</userinput></programlisting>
    363363
    364                                         <tip><para>Always put the trailing forward solidus at the
     364                                        <tip><para>Always put the trailing forward slash at the
    365365                                        end of a url, and remember to not include the filename
    366366                                        itself.</para></tip>
  • trunk/doc/guide/xml/quick.xml

    r3070 r3093  
    389389      <para>It is possible to use predefined lists of mirror sites in
    390390        your <filename>Portfile</filename>, such as SourceForge or GNU
    391         mirrors.  A full list of mirror site types is available in
    392         Chapter 3, 'Fetch phase'.  The straight-forward usage is:</para>
     391        mirrors.  The straight-forward usage is:</para>
    393392
    394393      <programlisting>master_sites                sourceforge http://distfiles.opendarwin.org/
    395394master_sites.mirror_subdir  ${name}</programlisting>
     395
     396      <para>In this example, <varname>sourceforge</varname> is the name
     397        of the mirror site list (See Chapter 3, 'Fetch Phase' for a list
     398        of all available mirror site lists),
     399        <varname>http://distfiles.opendarwin.org/</varname> is a normal
     400        <varname>master_sites</varname> URL, and
     401        <varname>${name}</varname> (the value of the
     402        <varname>name</varname> keyword in the
     403        <filename>Portfile</filename>) is the subdirectory to append to
     404        any mirror site lists specified.</para>
    396405
    397406      <para>This will search all of the mirror sites for SourceForge and
    398407        then http://distfiles.opendarwin.org, appending
    399408        <varname>${name}</varname> to the end of each SoureForge mirror
    400         site in the list, for example:</para>
    401 
    402       <programlisting>http://us.dl.sourceforge.net/${name}
    403 ftp://us.dl.sourceforge.net/pub/sourceforge/${name}</programlisting>
     409        site in the list.  This example will try to fetch from:</para>
     410
     411      <programlisting>http://us.dl.sourceforge.net/${name}/
     412ftp://us.dl.sourceforge.net/pub/sourceforge/${name}/
     413...
     414http://distfiles.opendarwin.org/</programlisting>
     415
     416      <para>Note that the value of
     417        <varname>master_sites.mirror_subdir</varname> is
     418        <emphasis>not</emphasis> appended to
     419        <varname>http://distfiles.opendarwin.org/</varname>, this URL is
     420        treated normally.  In this example
     421        <varname>master_sites.mirror_subdir</varname> is a required
     422        key.</para>
    404423
    405424      <para>You can also use the mirror site lists in
     
    599618      <title>Expat <filename>Portfile</filename></title>
    600619      <programlisting><![CDATA[########################### libxslt Portfile ##################################
    601 # $Id: quick.xml,v 1.13 2003/07/20 17:00:53 fkr Exp $
     620# $Id: quick.xml,v 1.14 2003/07/30 14:35:39 fkr Exp $
    602621
    603622PortSystem      1.0
     
    627646
    628647<programlisting><![CDATA[###########################neon Portfile####################################
    629 # $Id: quick.xml,v 1.13 2003/07/20 17:00:53 fkr Exp $
     648# $Id: quick.xml,v 1.14 2003/07/30 14:35:39 fkr Exp $
    630649         
    631650PortSystem 1.0
Note: See TracChangeset for help on using the changeset viewer.