[134582] trunk/doc-new/guide/xml

ionic at macports.org ionic at macports.org
Mon Mar 30 17:38:40 PDT 2015


Revision: 134582
          https://trac.macports.org/changeset/134582
Author:   ionic at macports.org
Date:     2015-03-30 17:38:40 -0700 (Mon, 30 Mar 2015)
Log Message:
-----------
doc-new/guide/xml: grammar fixes: correctly use e.g. instead of i.e. when necessary, use a trailing comma.

Modified Paths:
--------------
    trunk/doc-new/guide/xml/internals.xml
    trunk/doc-new/guide/xml/portfile-keywords.xml
    trunk/doc-new/guide/xml/portfile-variables.xml
    trunk/doc-new/guide/xml/portfile-variants.xml
    trunk/doc-new/guide/xml/portfiledev.xml
    trunk/doc-new/guide/xml/portgroup-python.xml
    trunk/doc-new/guide/xml/project.xml
    trunk/doc-new/guide/xml/using.xml

Modified: trunk/doc-new/guide/xml/internals.xml
===================================================================
--- trunk/doc-new/guide/xml/internals.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/internals.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -209,7 +209,7 @@
 
             <listitem>
               <para><code>mportexec:</code> Given a port handle, executes a
-              target (i.e. install).</para>
+              target (e.g., install).</para>
             </listitem>
 
             <listitem>

Modified: trunk/doc-new/guide/xml/portfile-keywords.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-keywords.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/portfile-keywords.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -37,7 +37,7 @@
         <para>The name of the port. To avoid special interpretation by shells
         and the like, names should contain only alphanumeric characters,
         underscores, dashes or dots. For projects whose proper names contain
-        <quote>+</quote> characters, change these to <quote>x</quote> (i.e.
+        <quote>+</quote> characters, change these to <quote>x</quote> (e.g.,
         <quote>libstdc++</quote> becomes <quote>libstdcxx</quote>).</para>
 
         <programlisting>name                foo</programlisting>
@@ -122,7 +122,7 @@
           </listitem>
 
           <listitem>
-            <para>For addresses in other domains, e.g.
+            <para>For addresses in other domains, e.g.,
             <email>account at example.org</email>, use the convention
             example.org:account to specify the address.</para>
           </listitem>

Modified: trunk/doc-new/guide/xml/portfile-variables.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-variables.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/portfile-variables.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -133,7 +133,7 @@
       <term>os.platform</term>
 
       <listitem>
-        <para>The underlying operating system platform (i.e.
+        <para>The underlying operating system platform (e.g.,
         <quote>darwin</quote> on OS X, <quote>freebsd</quote>,
         etc.).</para>
       </listitem>
@@ -152,7 +152,7 @@
       <term>os.version</term>
 
       <listitem>
-        <para>The version number of the host operating system (i.e.
+        <para>The version number of the host operating system (e.g.,
         <quote>12.3.0</quote> for Darwin 12.3.0 a.k.a. OS X 10.8.3).</para>
       </listitem>
     </varlistentry>
@@ -170,7 +170,7 @@
       <term>os.major</term>
 
       <listitem>
-        <para>The major version number of the host operating system (i.e.
+        <para>The major version number of the host operating system (e.g.,
         <quote>12</quote> for Darwin 12.x).</para>
       </listitem>
     </varlistentry>

Modified: trunk/doc-new/guide/xml/portfile-variants.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-variants.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/portfile-variants.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -201,7 +201,7 @@
 
     <note>
       <para>Though a combination of OS version and hardware platform may be
-      specified in a single platform statement (i.e. darwin 8 i386), it is not
+      specified in a single platform statement (e.g., darwin 8 i386), it is not
       possible to specify a range of platforms with a single statement. For
       example, to select Darwin versions 9 and 10 while excluding all others,
       you would need two statements: <code>platform darwin 9</code> and

Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/portfiledev.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -1177,7 +1177,7 @@
       the possibility to build ones port(s) on specific builders.</para>
       
       <para>Thus the buildbot helps to keep MacPorts consistent on various
-      OSX versions, i.e. a maintainer does not need access to these versions anymore in
+      OSX versions, i.e., a maintainer does not need access to these versions anymore in
       order to assure that the port(s) maintained build without problems. Currently only
       the default port variants will be build and kept.</para>
 

Modified: trunk/doc-new/guide/xml/portgroup-python.xml
===================================================================
--- trunk/doc-new/guide/xml/portgroup-python.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/portgroup-python.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -57,11 +57,11 @@
         <term>python.default_version</term>
 
         <listitem>
-          <para>For modules (i.e. name starts with <quote>py-</quote>), this sets the
+          <para>For modules (i.e., name starts with <quote>py-</quote>), this sets the
           subport that will be installed if the user asks to install <quote>py-foo</quote>
-          rather than e.g. <quote>py26-foo</quote> or <quote>py27-foo</quote>. If not explicitly set, a
+          rather than, e.g., <quote>py26-foo</quote> or <quote>py27-foo</quote>. If not explicitly set, a
           reasonable default is chosen from the list in <code>python.versions</code>.</para>
-          <para>For apps (i.e. name does not start with <quote>py-</quote>), this chooses
+          <para>For apps (i.e., name does not start with <quote>py-</quote>), this chooses
           which version of python to use, and must be set. It can be changed
           in variants if desired.</para>
 
@@ -187,7 +187,7 @@
         <term>python.lib</term>
 
         <listitem>
-          <para>The Python dynamic library path, i.e.
+          <para>The Python dynamic library path, i.e.,
           <filename>${python.prefix}/Python</filename> (framework builds) or
           <filename>${prefix}/lib/libpython2.4.dylib</filename> (python24).</para>
         </listitem>
@@ -197,7 +197,7 @@
         <term>python.libdir</term>
 
         <listitem>
-          <para>The path to python's lib directory, i.e.
+          <para>The path to python's lib directory, i.e.,
           <filename>${python.prefix}/lib/python${python.branch}</filename>.</para>
         </listitem>
       </varlistentry>

Modified: trunk/doc-new/guide/xml/project.xml
===================================================================
--- trunk/doc-new/guide/xml/project.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/project.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -280,7 +280,7 @@
           reporter and assignee who would like to be kept involved in the
           development of the ticket. Multiple email addresses should be
           separated with a comma and a space
-          (i.e. <literal>you at example.org, maintainer at macports.org</literal>).</para>
+          (e.g., <literal>you at example.org, maintainer at macports.org</literal>).</para>
           
           <para>When reporting port-related tickets, make sure you add the
           port maintainers email address to the <guilabel>Cc:</guilabel> field
@@ -876,7 +876,7 @@
 
     <itemizedlist>
         <listitem>
-          <para>approving new project members (i.e. granting commit
+          <para>approving new project members (i.e., granting commit
           rights);</para>
         </listitem>
 

Modified: trunk/doc-new/guide/xml/using.xml
===================================================================
--- trunk/doc-new/guide/xml/using.xml	2015-03-31 00:38:18 UTC (rev 134581)
+++ trunk/doc-new/guide/xml/using.xml	2015-03-31 00:38:40 UTC (rev 134582)
@@ -33,7 +33,7 @@
 
 Upgrade MacPorts itself and run the sync target
 
---nosync   Do not run the sync target, i.e. do not update the ports tree.
+--nosync   Do not run the sync target, i.e., do not update the ports tree.
            Only checks for (and installs, if available) new versions of
            MacPorts.</screen>
         </section>
@@ -424,7 +424,7 @@
                 <varlistentry>
                     <term><option>--no-build</option></term>
                     <listitem>
-                        <para>Exclude dependencies only required at build time, i.e. fetch, extract, and build
+                        <para>Exclude dependencies only required at build time, i.e., fetch, extract, and build
                             dependencies.</para>
                     </listitem>
                 </varlistentry>
@@ -874,7 +874,7 @@
                     <listitem>
                         <para>If the installed variants do not match those requested, upgrade (and change variants) even
                             if the port is not outdated. You can use this to switch the variant selection on an
-                            installed port, e.g. using</para>
+                            installed port, e.g., using</para>
 
                         <programlisting><prompt>$ </prompt><userinput>sudo port upgrade --enforce-variants apache2 -preforkmpm +workermpm</userinput></programlisting>
 
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20150330/989dc815/attachment.html>


More information about the macports-changes mailing list