Changeset 134587 for trunk/doc-new


Ignore:
Timestamp:
Mar 31, 2015, 12:39:17 AM (4 years ago)
Author:
ionic@…
Message:

doc-new/guide/xml: indentation and whitespace fixes.

Location:
trunk/doc-new/guide/xml
Files:
8 edited

Legend:

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

    r134583 r134587  
    650650    </section>
    651651  </section>
    652  
     652
    653653</chapter>
  • trunk/doc-new/guide/xml/macports.conf.xml

    r126075 r134587  
    9191        </listitem>
    9292      </varlistentry>
    93      
     93
    9494      <varlistentry>
    9595        <term>build_arch</term>
     
    109109
    110110        <listitem>
    111                   <para>Directory to install MacPorts that install OS X .app
    112                           bundles.</para>
     111            <para>Directory to install MacPorts that install OS X .app
     112                bundles.</para>
    113113
    114114          <para>Default: <filename>/Applications/MacPorts</filename></para>
     
    126126        </listitem>
    127127      </varlistentry>
    128      
     128
    129129      <varlistentry>
    130130        <term>developer_dir</term>
     
    300300        <listitem>
    301301          <para>Space separated list of download hosts that should not be used.</para>
    302          
     302
    303303          <para>Default: none</para>
    304          
     304
    305305          <note>
    306306            <para>This feature is especially useful if a host turns out to be consistently
     
    315315        <listitem>
    316316          <para>Space separated list of download hosts that should be used preferentially.</para>
    317          
     317
    318318          <para>Default: none</para>
    319319        </listitem>
     
    326326          <para>Controls whether the rev-upgrade action will be run automatically after
    327327          upgrading ports.</para>
    328          
     328
    329329          <para>Default: yes</para>
    330330        </listitem>
     
    339339          when broken linking is detected in their files, while 'report' means broken
    340340          files will be scanned for and reported but the ports will not be rebuilt.</para>
    341          
     341
    342342          <para>Default: rebuild</para>
    343343        </listitem>
  • trunk/doc-new/guide/xml/portfile-dependencies.xml

    r126075 r134587  
    141141    for any installed file. File dependencies are specified in the form:
    142142    <replaceable>&lt;type&gt;</replaceable>:<replaceable>&lt;filespec&gt;</replaceable>:<replaceable>&lt;port&gt;</replaceable>.</para>
    143    
     143
    144144    <para>For <option>bin</option> dependencies,
    145145    <replaceable>&lt;filespec&gt;</replaceable> is the name of a program in a
    146146    bin directory like <filename>${prefix}/bin</filename>, /usr/bin, /bin, and
    147147    the associated sbin directories.</para>
    148    
     148
    149149    <para>For <option>lib</option> dependencies,
    150150    <replaceable>&lt;filespec&gt;</replaceable> is the name of a library
     
    152152    <filename>${prefix}/lib</filename>, /usr/lib, /lib, some Framework
    153153    directories, and those found in environment variables like DYLD_LIBRARY_PATH.</para>
    154    
     154
    155155    <para>For <option>path</option> dependencies,
    156156    <replaceable>&lt;filespec&gt;</replaceable> is the complete absolute path
  • trunk/doc-new/guide/xml/portfile-keywords.xml

    r134582 r134587  
    227227        </para>
    228228
    229                 <para>If the version number is a
    230                 <quote>.0</quote> version, the <quote>.0</quote> should be
    231                 omitted to make the version an integer. If the author gives the choice
    232                 of using a given license or <quote>any later version</quote> of it,
    233                 append a plus sign (+) to the version number. If the version
    234                 specified in this case is also the earliest version,
    235                 just leave out the version number entirely since it implies all
    236                 versions.</para>
     229        <para>If the version number is a
     230        <quote>.0</quote> version, the <quote>.0</quote> should be
     231        omitted to make the version an integer. If the author gives the choice
     232        of using a given license or <quote>any later version</quote> of it,
     233        append a plus sign (+) to the version number. If the version
     234        specified in this case is also the earliest version,
     235        just leave out the version number entirely since it implies all
     236        versions.</para>
    237237
    238238        <programlisting>license           GPL-3</programlisting>
  • trunk/doc-new/guide/xml/portfile-phase.xml

    r134584 r134587  
    10891089        </listitem>
    10901090      </varlistentry>
    1091        
     1091
    10921092      <varlistentry>
    10931093        <term>extract.suffix</term>
     
    20712071              10.5</para>
    20722072            </listitem>
    2073            
     2073
    20742074            <listitem>
    20752075              <para>Default: <option>gcc-4.2</option> with Xcode 3.2 on Mac OS X 10.6</para>
     
    28482848        </listitem>
    28492849      </varlistentry>
    2850      
     2850
    28512851      <varlistentry>
    28522852        <term>build.jobs</term>
     
    28682868        </listitem>
    28692869      </varlistentry>
    2870      
     2870
    28712871    </variablelist>
    28722872  </section>
  • trunk/doc-new/guide/xml/portfiledev.xml

    r134584 r134587  
    682682@@ -131,23 +131,23 @@
    683683        $(INSTALL_DATA)/gdata $(INSTALL_DATA)/perl
    684 
     684 
    685685 install-lib:
    686686-       -mkdir -p $(INSTALL_LIB)
     
    859859      <programlisting>checksums               rmd160  7bbfce4fecc2a8e1ca081169e70c1a298ab1b75a \
    860860                        sha256  2829fcb7393bac85925090b286b1f9c3cd3fbbf8e7f35796ef4131322509aa53</programlisting>
    861      
     861
    862862      <para>Should a key item such as a phase or variant require braces, the
    863863      opening brace should appear on the same line and the closing brace should
     
    866866      variants, are placed on the same line without line breaks.</para>
    867867
    868     <programlisting>variant mysql5 description {Enable support for MySQL 5} {
     868      <programlisting>variant mysql5 description {Enable support for MySQL 5} {
    869869    depends_lib-append        port:mysql5
    870870    configure.args-replace    --without-mysql5 --with-mysql5
     
    917917      renaming is necessary for some reason, the port should be marked as
    918918      <code>replaced_by</code>.</para>
    919      
     919
    920920      <para>As an illustration of a typical workflow the port
    921921      <quote>skrooge-devel</quote> shall be taken. This port had been used for
     
    923923      unnecessary due to the fact that skrooge's developers currently prefer a
    924924      distribution via port <quote>skrooge</quote> instead. </para>
    925      
     925
    926926      <para>At the end of this section the use of the obsolete PortGroup is suggested
    927927      as an even shorter approach to the below described workflow.</para>
    928928
    929929      <section id="development.replaced_by">
    930       <title>The long way</title>
    931 
    932       <para>Skrooge's original devel port file looked like this:</para>
    933 
    934 <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
     930        <title>The long way</title>
     931
     932        <para>Skrooge's original devel port file looked like this:</para>
     933
     934        <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
    935935# $Id$
    936936
     
    970970                    port:oxygen-icons</programlisting>
    971971
    972         <para>The following steps have to be taken to ensure a smooth transition
    973         for a MacPorts user updating his local installation using
    974         <userinput>sudo port upgrade</userinput>:</para>
    975 
    976     <orderedlist>
    977       <listitem>
    978         <para> add the line <code>replaced_by foo</code> where foo is the
    979         port this one is replaced by; when a user upgrades this port,
    980         MacPorts will instead install the replacement port</para>
    981                 <programlisting>replaced_by         skrooge</programlisting>
    982       </listitem>
    983 
    984       <listitem>
    985         <para> increase the version, revision, or epoch, so that users who
    986         have this port installed will get notice in <code>port
    987         outdated</code> that they should upgrade it and trigger the above
    988         process</para>
    989                 <programlisting>revision            1</programlisting>
    990       </listitem>
    991 
    992       <listitem>
    993         <para> clear distfiles (have a line reading only
    994         <code>distfiles</code>) so that no distfile is downloaded for this
    995         stub port</para>
    996                 <programlisting>distfiles</programlisting>
    997       </listitem>
    998 
    999       <listitem>
    1000         <para> delete master_sites since there aren't any distfiles to
    1001         download</para>
    1002       </listitem>
    1003 
    1004       <listitem>
    1005         <para> disable livecheck</para>
    1006         <programlisting>livecheck.type      none</programlisting>
    1007       </listitem>
    1008 
    1009       <listitem>
    1010         <para> add a pre-configure block with a <code>ui_error</code> and
    1011         <code>return -code error</code> explaining to users who try to
    1012         install this port that the port has been replaced</para>
    1013                 <programlisting>pre-configure {
     972        <para>The following steps have to be taken to ensure a smooth transition
     973          for a MacPorts user updating his local installation using
     974          <userinput>sudo port upgrade</userinput>:</para>
     975
     976        <orderedlist>
     977          <listitem>
     978            <para> add the line <code>replaced_by foo</code> where foo is the
     979              port this one is replaced by; when a user upgrades this port,
     980              MacPorts will instead install the replacement port</para>
     981            <programlisting>replaced_by         skrooge</programlisting>
     982          </listitem>
     983
     984          <listitem>
     985            <para> increase the version, revision, or epoch, so that users who
     986              have this port installed will get notice in <code>port
     987                outdated</code> that they should upgrade it and trigger the above
     988              process</para>
     989            <programlisting>revision            1</programlisting>
     990          </listitem>
     991
     992          <listitem>
     993            <para> clear distfiles (have a line reading only
     994              <code>distfiles</code>) so that no distfile is downloaded for this
     995              stub port</para>
     996            <programlisting>distfiles</programlisting>
     997          </listitem>
     998
     999          <listitem>
     1000            <para> delete master_sites since there aren't any distfiles to
     1001              download</para>
     1002          </listitem>
     1003
     1004          <listitem>
     1005            <para> disable livecheck</para>
     1006            <programlisting>livecheck.type      none</programlisting>
     1007          </listitem>
     1008
     1009          <listitem>
     1010            <para> add a pre-configure block with a <code>ui_error</code> and
     1011              <code>return -code error</code> explaining to users who try to
     1012              install this port that the port has been replaced</para>
     1013            <programlisting>pre-configure {
    10141014    ui_error "Please do not install this port since it has been replaced by 'skrooge'."
    10151015    return -code error
    10161016}</programlisting>
    1017       </listitem>
    1018     </orderedlist>
    1019 
    1020         <para>With above modifications the port file eventually looks like
    1021         this:</para>
    1022 
    1023 <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
     1017          </listitem>
     1018        </orderedlist>
     1019
     1020        <para>With above modifications the port file eventually looks like
     1021          this:</para>
     1022
     1023        <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
    10241024# $Id$
    10251025
     
    10541054distfiles</programlisting>
    10551055
    1056         <para>A user upgrading ports will experience the following for port
    1057   <quote>skrooge-devel</quote>:</para>
    1058         <programlisting><prompt>%%</prompt> <userinput>sudo port upgrade skrooge-devel</userinput></programlisting>
    1059         <screen>--->  skrooge-devel is replaced by skrooge
     1056        <para>A user upgrading ports will experience the following for port
     1057          <quote>skrooge-devel</quote>:</para>
     1058        <programlisting><prompt>%%</prompt> <userinput>sudo port upgrade skrooge-devel</userinput></programlisting>
     1059        <screen>--->  skrooge-devel is replaced by skrooge
    10601060--->  Computing dependencies for skrooge
    10611061--->  Fetching skrooge
     
    10761076# launchctl load /Library/LaunchAgents/org.freedesktop.dbus-session.plist
    10771077##########################################################
    1078  
     1078
    10791079######################################################
    10801080#  Programs will not start until you run the command
     
    10841084--->  Cleaning skrooge</screen>
    10851085
    1086         <para>In case a user actually tries to install the obsolete port
    1087         <quote>skrooge-devel</quote> it would be pointed out by an error message that
    1088   this is impossible now:</para>
    1089         <programlisting><prompt>%%</prompt> <userinput>sudo port install skrooge-devel</userinput></programlisting>
    1090         <screen>--->  Fetching skrooge-devel
     1086        <para>In case a user actually tries to install the obsolete port
     1087          <quote>skrooge-devel</quote> it would be pointed out by an error message that
     1088          this is impossible now:</para>
     1089        <programlisting><prompt>%%</prompt> <userinput>sudo port install skrooge-devel</userinput></programlisting>
     1090        <screen>--->  Fetching skrooge-devel
    10911091--->  Verifying checksum(s) for skrooge-devel
    10921092--->  Extracting skrooge-devel
     
    10981098To report a bug, see &lt;http://guide.macports.org/#project.tickets&gt;</screen>
    10991099
    1100         </section>
    1101 
    1102     <section id="development.obsolete-portgroup">
    1103     <title>The shortcut: PortGroup obsolete</title>
    1104 
    1105         <para>Using the PortGroup obsolete makes the task described in the previous subsection
    1106         much easier:</para>
    1107 
    1108         <programlisting>
     1100      </section>
     1101
     1102      <section id="development.obsolete-portgroup">
     1103        <title>The shortcut: PortGroup obsolete</title>
     1104
     1105        <para>Using the PortGroup obsolete makes the task described in the previous subsection
     1106          much easier:</para>
     1107
     1108        <programlisting>
    11091109# -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
    11101110# $Id$
     
    11171117revision            2</programlisting>
    11181118
    1119         <para>The PortGroup defines a number of reasonable defaults for a port that is only
    1120         there to inform users that they should uninstall it and install something else
    1121         instead. You might want to override some of the defaults though. For details have
    1122         a look at the PortGroup's source code in
    1123         <filename>${prefix}/var/macports/sources/rsync.macports.org/release/ports/_resources/port1.0/group/obsolete-1.0.tcl</filename>.</para>
    1124 
    1125       <note>
    1126         <para>It is important to specify <varname>replaced_by</varname> BEFORE the
     1119        <para>The PortGroup defines a number of reasonable defaults for a port that is only
     1120          there to inform users that they should uninstall it and install something else
     1121          instead. You might want to override some of the defaults though. For details have
     1122          a look at the PortGroup's source code in
     1123          <filename>${prefix}/var/macports/sources/rsync.macports.org/release/ports/_resources/port1.0/group/obsolete-1.0.tcl</filename>.</para>
     1124
     1125        <note>
     1126          <para>It is important to specify <varname>replaced_by</varname> BEFORE the
    11271127            <varname>PortGroup</varname> line!</para>
    1128       </note>
    1129 
    1130     </section>
    1131 
    1132     </section>
    1133    
    1134    
     1128        </note>
     1129
     1130      </section>
     1131
     1132    </section>
     1133
    11351134    <section id="development.practices.removing-port">
    11361135      <title>Removing a port</title>
    11371136
    11381137      <para>If a port has to be removed from MacPorts one should consider
    1139       the hints concerning replacing it by some alternative port given
    1140       <link linkend="development.practices.rename-replace-port">above</link>.
    1141       It is recommended to wait one year before the port directory
    1142       is actually removed from MacPorts' Subversion repository.
     1138        the hints concerning replacing it by some alternative port given
     1139        <link linkend="development.practices.rename-replace-port">above</link>.
     1140        It is recommended to wait one year before the port directory
     1141        is actually removed from MacPorts' Subversion repository.
    11431142      </para>
    11441143
    11451144      <para>If there is no replacement for a port, it can simply be deleted
    1146       immediately.</para>
    1147  
    1148         </section>
    1149    
     1145        immediately.</para>
     1146
     1147    </section>
     1148
    11501149  </section>
    11511150
    11521151  <section id="development.buildbot">
    1153   <title>MacPorts' buildbot</title>
    1154 
    1155       <para>The <ulink url="https://build.macports.org/">buildbot</ulink> is a port
     1152    <title>MacPorts' buildbot</title>
     1153
     1154    <para>The <ulink url="https://build.macports.org/">buildbot</ulink> is a port
    11561155      build-service currently supporting building of all committed ports for Snow Leopard,
    11571156      Lion, and Mountain Lion using the MacPorts AutoBuild
    11581157      (<ulink url="http://svn.macports.org/repository/macports/contrib/mpab/">MPAB</ulink>)
    11591158      scripts.</para>
    1160      
    1161       <para>Every time a maintainer commits changes to MacPorts' central SVN repository
     1159
     1160    <para>Every time a maintainer commits changes to MacPorts' central SVN repository
    11621161      the buildbot will check whether a rebuild of the corresponding port(s) would
    11631162      be necessary. If the port(s) in question are distributable their binary
    11641163      archives will be kept for subsequent distribution for the three most current
    11651164      versions of the OS X operating system.</para>
    1166      
    1167       <para>If a build error occurred for a port its maintainer will be informed via
     1165
     1166    <para>If a build error occurred for a port its maintainer will be informed via
    11681167      an email so that problems which did not surface on the maintainer's machine will
    11691168      not go unnoticed.
    1170      
     1169
    11711170      Port maintainers will find the
    11721171      <ulink url="https://build.macports.org/waterfall">waterfall</ulink>
    1173       and the 
     1172      and the
    11741173      <ulink url="https://build.macports.org/builders">builders</ulink>
    11751174      views most useful since they give information about the build status and offer
    11761175      the possibility to build ones port(s) on specific builders.</para>
    1177      
    1178       <para>Thus the buildbot helps to keep MacPorts consistent on various
     1176
     1177    <para>Thus the buildbot helps to keep MacPorts consistent on various
    11791178      OSX versions, i.e., a maintainer does not need access to these versions anymore in
    11801179      order to assure that the port(s) maintained build without problems. Currently only
     
    11821181
    11831182  </section>
    1184  
     1183
    11851184</chapter>
  • trunk/doc-new/guide/xml/portgroups.xml

    r134581 r134587  
    3939   portgroup is used. Prospective MacPorts developers are also encouraged to examine existing
    4040   portfiles that use these portgroups.</para>
    41    
     41
    4242</section>
  • trunk/doc-new/guide/xml/project.xml

    r134585 r134587  
    165165              intended purpose.</para>
    166166            </listitem>
    167            
     167
    168168            <listitem>
    169169              <para><guimenu>update</guimenu> - Tickets, with or without
     
    171171              version.</para>
    172172            </listitem>
    173            
     173
    174174            <listitem>
    175175              <para><guimenu>submission</guimenu> - Tickets created to submit
     
    177177              </para>
    178178            </listitem>
    179            
     179
    180180            <listitem>
    181181              <para><guimenu>request</guimenu> - Tickets created to request
     
    281281          separated with a comma and a space
    282282          (e.g., <literal>you@example.org, maintainer@macports.org</literal>).</para>
    283          
     283
    284284          <para>When reporting port-related tickets, make sure you add the
    285285          port maintainers email address to the <guilabel>Cc:</guilabel> field
     
    290290          </literal></para>
    291291        </listitem>
    292        
     292
    293293        <listitem>
    294294          <para><guilabel>Assign To:</guilabel> Only users with commit access
    295295          can edit this field. If this is not you, see the section on the
    296296          <guimenu>Cc</guimenu> field above.</para>
    297          
     297
    298298          <para>For tickets on ports, enter
    299299          the email address of the port's maintainer (use <command>port info
     
    788788        </listitem>
    789789
    790                 <listitem>
    791                   <para>In the Port field, indicate which port is abandoned.</para>
    792                 </listitem>
     790        <listitem>
     791          <para>In the Port field, indicate which port is abandoned.</para>
     792        </listitem>
    793793
    794794        <listitem>
Note: See TracChangeset for help on using the changeset viewer.