Changeset 134583


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

doc-new/guide/xml: grammar fixes: the markup makes clear whether the given string is a command, an option, a file or a variable. Don't be redundant about it.

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

Legend:

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

    r134581 r134583  
    208208                    <para>After this step you are done already, MacPorts is now installed and your shell environment was
    209209                        set up automatically by the installer. To confirm the installation is working as expected, now
    210                         try using the <command>port</command> command in a <emphasis>new</emphasis> terminal
     210                        try using <command>port</command> in a <emphasis>new</emphasis> terminal
    211211                        window.</para>
    212212
     
    293293
    294294                    <para>MacPorts uses autoconf and makefiles for installation. These commands will build and install
    295                         MacPorts to <filename>/opt/local</filename>. You can add the <option>--prefix</option> option to
     295                        MacPorts to <filename>/opt/local</filename>. You can add <option>--prefix</option> to
    296296                        <filename>./configure</filename> to relocate MacPorts to another directory if needed.</para>
    297297
     
    374374            first.</para>
    375375
    376         <para>If you need to uninstall MacPorts, and your <command>port</command> command is functioning, first
     376        <para>If you need to uninstall MacPorts, and <command>port</command> is functioning, first
    377377        uninstall all the installed ports by running this command in the Terminal:</para>
    378378
     
    490490            <para>To verify that the file containing the MacPorts variables is in effect, type <command>env</command> in
    491491                the terminal to verify the current environment settings after the file has been created. Example output
    492                 for the <command>env</command> command is shown below.</para>
     492                for <command>env</command> is shown below.</para>
    493493
    494494            <note>
  • trunk/doc-new/guide/xml/internals.xml

    r134582 r134583  
    216216              <para><code>mportinfo:</code> Given a port handle, this returns
    217217              the PortInfo array (as a flat list of array elements). This is a
    218               little tricky and unstable and only used by the
    219               <command>portindex</command> command.</para>
     218              little tricky and unstable and only used by
     219              <command>portindex</command>.</para>
    220220            </listitem>
    221221
     
    322322      the additional directory <filename>portfiles</filename> is used
    323323      temporarily for extracting stored Portfiles from the registry.
    324       Furthermore, access to the registry may be locked using the
    325       <filename>.registry.lock</filename> file with the
     324      Furthermore, access to the registry may be locked using
     325      <filename>.registry.lock</filename> with the
    326326      <computeroutput>registry::exclusive_lock</computeroutput> and
    327327      <computeroutput>registry::exclusive_unlock</computeroutput> APIs.</para>
  • trunk/doc-new/guide/xml/portfiledev.xml

    r134582 r134583  
    652652<prompt>%%</prompt> <userinput>diff -u src/Makefile.in.orig src/Makefile.in &gt; patch-src-Makefile.in.diff</userinput></programlisting>
    653653
    654           <para>You should execute the <command>diff</command> command from
     654          <para>You should execute <command>diff</command> from
    655655          the top-level directory of the unpacked source code, because during
    656656          the patch phase MacPorts by default uses the patch argument
     
    676676          easiest to interpret by humans and this type should always be used
    677677          for ports. See the example below where a patch adds
    678           <varname>DESTDIR</varname> support to a
    679           <filename>Makefile.in</filename> file.</para>
     678          <varname>DESTDIR</varname> support to <filename>Makefile.in</filename>.</para>
    680679
    681680          <programlisting>--- src/Makefile.in.orig   2007-06-01 16:30:47.000000000 -0700
     
    746745    <orderedlist>
    747746      <listitem>
    748         <para>Open the <filename>sources.conf</filename> file in a text
     747        <para>Open <filename>sources.conf</filename> in a text
    749748        editor. For example, to open it into TextEdit:</para>
    750749
     
    763762          <para>The file URL should always appear before the rsync URL so that
    764763          local Portfiles can be tested that are duplicated in the MacPorts
    765           tree, because the <command>port</command> command will always
     764          tree, because <command>port</command> will always
    766765          operate on the first Portfile it encounters.</para>
    767766        </note>
     
    795794
    796795      <listitem>
    797         <para>After you create or update your Portfile, use the MacPorts
    798         <command>portindex</command> command in the local repository's
     796        <para>After you create or update your Portfile, use
     797        <command>portindex</command> in the local repository's
    799798        directory to create or update the index of the ports in your local
    800799        repository.</para>
  • trunk/doc-new/guide/xml/using.xml

    r134582 r134583  
    1010    <title>Using MacPorts</title>
    1111
    12     <para>This chapter describes using the <command>port</command> command, port variants, common tasks and port
     12    <para>This chapter describes using <command>port</command>, port variants, common tasks and port
    1313    binaries.</para>
    1414
     
    1616        <title>The port Command</title>
    1717
    18         <para>The MacPorts <command>port</command> command is the main utility used to interact with MacPorts. It is
     18        <para><command>port</command> is the main utility used to interact with MacPorts. It is
    1919            used to update <filename>Portfile</filename>s and the MacPorts infrastructure, and install and manage
    2020            ports.</para>
     
    2424
    2525            <para>The <option>help</option> action shows some brief information about the specified action, or if no
    26                 action is specified, shows basic usage information for the <command>port</command> command in
    27                 general.</para>
     26                action is specified, shows basic usage information for <command>port</command> in general.</para>
    2827
    2928            <programlisting><prompt>$</prompt> <userinput>port help selfupdate</userinput></programlisting>
     
    460459                While <option>()</option> are derived from the <filename>variants.conf</filename>.
    461460                See <xref
    462                     linkend="internals.configuration-files.variants-conf" /> for more information on the
    463                 <filename>variants.conf</filename> file.</para>
     461                    linkend="internals.configuration-files.variants-conf" /> for more information on
     462                <filename>variants.conf</filename>.</para>
    464463        </section>
    465464
     
    482481            <programlisting><prompt>$ </prompt><userinput>sudo port -v install apache2</userinput></programlisting>
    483482
    484             <para>All debug information is also kept in the <filename>main.log</filename> file for the port you
     483            <para>All debug information is also kept in <filename>main.log</filename> for the port you
    485484                installed. Its path will be printed automatically if the installation fails. You can manually get the
    486485                path using <command>port logfile <varname>&lt;portname&gt;</varname></command>. Note that logfiles will
     
    782781  zlib @1.2.8_0 (active)</screen>
    783782
    784             <para>Use the <option>-v</option> option to also display the platform and CPU architecture(s) for which the
     783            <para>Use <option>-v</option> to also display the platform and CPU architecture(s) for which the
    785784                ports were built, and any variants which were explicitly negated.</para>
    786785
     
    848847                <para>to go back to the old version.</para>
    849848
    850                 <para>If you do not want to keep the old versions around while upgrading, you can pass the
    851                     <option>-u</option> option when upgrading:</para>
     849                <para>If you do not want to keep the old versions around while upgrading, you can pass
     850                    <option>-u</option> when upgrading:</para>
    852851
    853852                <programlisting><prompt>$ </prompt><userinput>sudo port -u upgrade outdated</userinput></programlisting>
     
    10211020                While <option>()</option> are derived from the <filename>variants.conf</filename>.
    10221021                See <xref
    1023                     linkend="internals.configuration-files.variants-conf" /> for more information on the
    1024             <filename>variants.conf</filename> file.</para>
     1022                    linkend="internals.configuration-files.variants-conf" /> for more information on
     1023            <filename>variants.conf</filename>.</para>
    10251024
    10261025        <section id="using.variants.invoking">
     
    15001499
    15011500            <para>Binary archive files are placed in <filename>${prefix}/var/macports/software/</filename>. The archive
    1502                 file type is set in the <filename>macports.conf</filename> file using the
     1501                file type is set in <filename>macports.conf</filename> using the
    15031502                <option>portarchivetype</option> key. The default format is <option>tbz2</option>; other options are:
    15041503                <option>tar</option>, <option>tbz</option>, <option>tbz2</option>, <option>tgz</option>,
     
    15151514                usually <option>.pkg</option> (OS X Installer Packages). MacPorts can also convert
    15161515                a <option>.pkg</option> package into an OS X <option>.dmg</option> disk image. You can create binary
    1517                 packages with the <command>port</command> command as shown in the following examples.</para>
     1516                packages using <command>port</command> as shown in the following examples.</para>
    15181517
    15191518            <warning>
Note: See TracChangeset for help on using the changeset viewer.