[134583] trunk/doc-new/guide/xml
ionic at macports.org
ionic at macports.org
Mon Mar 30 17:38:47 PDT 2015
Revision: 134583
https://trac.macports.org/changeset/134583
Author: ionic at macports.org
Date: 2015-03-30 17:38:47 -0700 (Mon, 30 Mar 2015)
Log 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.
Modified Paths:
--------------
trunk/doc-new/guide/xml/installing.xml
trunk/doc-new/guide/xml/internals.xml
trunk/doc-new/guide/xml/portfiledev.xml
trunk/doc-new/guide/xml/using.xml
Modified: trunk/doc-new/guide/xml/installing.xml
===================================================================
--- trunk/doc-new/guide/xml/installing.xml 2015-03-31 00:38:40 UTC (rev 134582)
+++ trunk/doc-new/guide/xml/installing.xml 2015-03-31 00:38:47 UTC (rev 134583)
@@ -207,7 +207,7 @@
<listitem>
<para>After this step you are done already, MacPorts is now installed and your shell environment was
set up automatically by the installer. To confirm the installation is working as expected, now
- try using the <command>port</command> command in a <emphasis>new</emphasis> terminal
+ try using <command>port</command> in a <emphasis>new</emphasis> terminal
window.</para>
<programlisting><prompt>$</prompt> <userinput>port version</userinput></programlisting>
@@ -292,7 +292,7 @@
<para>Build and Install MacPorts</para>
<para>MacPorts uses autoconf and makefiles for installation. These commands will build and install
- MacPorts to <filename>/opt/local</filename>. You can add the <option>--prefix</option> option to
+ MacPorts to <filename>/opt/local</filename>. You can add <option>--prefix</option> to
<filename>./configure</filename> to relocate MacPorts to another directory if needed.</para>
<programlisting><prompt>$</prompt> <userinput>cd /opt/mports/trunk/base</userinput>
@@ -373,7 +373,7 @@
url="http://lists.macosforge.org/mailman/listinfo/macports-users">macports-users</ulink> mailing list
first.</para>
- <para>If you need to uninstall MacPorts, and your <command>port</command> command is functioning, first
+ <para>If you need to uninstall MacPorts, and <command>port</command> is functioning, first
uninstall all the installed ports by running this command in the Terminal:</para>
<programlisting><prompt>$</prompt> <userinput>sudo port -fp uninstall installed</userinput></programlisting>
@@ -489,7 +489,7 @@
<para>To verify that the file containing the MacPorts variables is in effect, type <command>env</command> in
the terminal to verify the current environment settings after the file has been created. Example output
- for the <command>env</command> command is shown below.</para>
+ for <command>env</command> is shown below.</para>
<note>
<para>Changes to shell configuration files do not take effect until a new terminal session is
Modified: trunk/doc-new/guide/xml/internals.xml
===================================================================
--- trunk/doc-new/guide/xml/internals.xml 2015-03-31 00:38:40 UTC (rev 134582)
+++ trunk/doc-new/guide/xml/internals.xml 2015-03-31 00:38:47 UTC (rev 134583)
@@ -215,8 +215,8 @@
<listitem>
<para><code>mportinfo:</code> Given a port handle, this returns
the PortInfo array (as a flat list of array elements). This is a
- little tricky and unstable and only used by the
- <command>portindex</command> command.</para>
+ little tricky and unstable and only used by
+ <command>portindex</command>.</para>
</listitem>
<listitem>
@@ -321,8 +321,8 @@
stored in a single file named <filename>registry.db</filename>, although
the additional directory <filename>portfiles</filename> is used
temporarily for extracting stored Portfiles from the registry.
- Furthermore, access to the registry may be locked using the
- <filename>.registry.lock</filename> file with the
+ Furthermore, access to the registry may be locked using
+ <filename>.registry.lock</filename> with the
<computeroutput>registry::exclusive_lock</computeroutput> and
<computeroutput>registry::exclusive_unlock</computeroutput> APIs.</para>
Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml 2015-03-31 00:38:40 UTC (rev 134582)
+++ trunk/doc-new/guide/xml/portfiledev.xml 2015-03-31 00:38:47 UTC (rev 134583)
@@ -651,7 +651,7 @@
<programlisting><prompt>%%</prompt> <userinput>cd ~/Downloads/foo-1.34</userinput>
<prompt>%%</prompt> <userinput>diff -u src/Makefile.in.orig src/Makefile.in > patch-src-Makefile.in.diff</userinput></programlisting>
- <para>You should execute the <command>diff</command> command from
+ <para>You should execute <command>diff</command> from
the top-level directory of the unpacked source code, because during
the patch phase MacPorts by default uses the patch argument
<option>-p0</option>, which does not strip prefixes with any leading
@@ -675,8 +675,7 @@
<para>A patch file that is a <quote>unified</quote> diff file is the
easiest to interpret by humans and this type should always be used
for ports. See the example below where a patch adds
- <varname>DESTDIR</varname> support to a
- <filename>Makefile.in</filename> file.</para>
+ <varname>DESTDIR</varname> support to <filename>Makefile.in</filename>.</para>
<programlisting>--- src/Makefile.in.orig 2007-06-01 16:30:47.000000000 -0700
+++ src/Makefile.in 2007-06-20 10:10:59.000000000 -0700
@@ -745,7 +744,7 @@
<orderedlist>
<listitem>
- <para>Open the <filename>sources.conf</filename> file in a text
+ <para>Open <filename>sources.conf</filename> in a text
editor. For example, to open it into TextEdit:</para>
<programlisting><prompt>%%</prompt> <userinput>open -e ${prefix}/etc/macports/sources.conf</userinput></programlisting>
@@ -762,7 +761,7 @@
<note>
<para>The file URL should always appear before the rsync URL so that
local Portfiles can be tested that are duplicated in the MacPorts
- tree, because the <command>port</command> command will always
+ tree, because <command>port</command> will always
operate on the first Portfile it encounters.</para>
</note>
</listitem>
@@ -794,8 +793,8 @@
</listitem>
<listitem>
- <para>After you create or update your Portfile, use the MacPorts
- <command>portindex</command> command in the local repository's
+ <para>After you create or update your Portfile, use
+ <command>portindex</command> in the local repository's
directory to create or update the index of the ports in your local
repository.</para>
Modified: trunk/doc-new/guide/xml/using.xml
===================================================================
--- trunk/doc-new/guide/xml/using.xml 2015-03-31 00:38:40 UTC (rev 134582)
+++ trunk/doc-new/guide/xml/using.xml 2015-03-31 00:38:47 UTC (rev 134583)
@@ -9,13 +9,13 @@
<chapter id="using">
<title>Using MacPorts</title>
- <para>This chapter describes using the <command>port</command> command, port variants, common tasks and port
+ <para>This chapter describes using <command>port</command>, port variants, common tasks and port
binaries.</para>
<section id="using.port">
<title>The port Command</title>
- <para>The MacPorts <command>port</command> command is the main utility used to interact with MacPorts. It is
+ <para><command>port</command> is the main utility used to interact with MacPorts. It is
used to update <filename>Portfile</filename>s and the MacPorts infrastructure, and install and manage
ports.</para>
@@ -23,8 +23,7 @@
<title>port help</title>
<para>The <option>help</option> action shows some brief information about the specified action, or if no
- action is specified, shows basic usage information for the <command>port</command> command in
- general.</para>
+ action is specified, shows basic usage information for <command>port</command> in general.</para>
<programlisting><prompt>$</prompt> <userinput>port help selfupdate</userinput></programlisting>
@@ -459,8 +458,8 @@
Any <option>[]</option> are derived from the <filename>Portfile</filename>.
While <option>()</option> are derived from the <filename>variants.conf</filename>.
See <xref
- linkend="internals.configuration-files.variants-conf" /> for more information on the
- <filename>variants.conf</filename> file.</para>
+ linkend="internals.configuration-files.variants-conf" /> for more information on
+ <filename>variants.conf</filename>.</para>
</section>
<section id="using.port.install">
@@ -481,7 +480,7 @@
<programlisting><prompt>$ </prompt><userinput>sudo port -v install apache2</userinput></programlisting>
- <para>All debug information is also kept in the <filename>main.log</filename> file for the port you
+ <para>All debug information is also kept in <filename>main.log</filename> for the port you
installed. Its path will be printed automatically if the installation fails. You can manually get the
path using <command>port logfile <varname><portname></varname></command>. Note that logfiles will
automatically be deleted on successful installation.</para>
@@ -781,7 +780,7 @@
yubico-pam @2.16_0 (active)
zlib @1.2.8_0 (active)</screen>
- <para>Use the <option>-v</option> option to also display the platform and CPU architecture(s) for which the
+ <para>Use <option>-v</option> to also display the platform and CPU architecture(s) for which the
ports were built, and any variants which were explicitly negated.</para>
<programlisting><prompt>$ </prompt><userinput>port -v installed libsdl</userinput></programlisting>
@@ -847,8 +846,8 @@
<para>to go back to the old version.</para>
- <para>If you do not want to keep the old versions around while upgrading, you can pass the
- <option>-u</option> option when upgrading:</para>
+ <para>If you do not want to keep the old versions around while upgrading, you can pass
+ <option>-u</option> when upgrading:</para>
<programlisting><prompt>$ </prompt><userinput>sudo port -u upgrade outdated</userinput></programlisting>
@@ -1020,8 +1019,8 @@
Any <option>[]</option> are derived from the <filename>Portfile</filename>.
While <option>()</option> are derived from the <filename>variants.conf</filename>.
See <xref
- linkend="internals.configuration-files.variants-conf" /> for more information on the
- <filename>variants.conf</filename> file.</para>
+ linkend="internals.configuration-files.variants-conf" /> for more information on
+ <filename>variants.conf</filename>.</para>
<section id="using.variants.invoking">
<title>Invoking Variants</title>
@@ -1499,7 +1498,7 @@
<!-- -->DEBUG: Archive logrotate-3.8.6_2+gzip.darwin_13.x86_64.tbz2 packaged</screen>
<para>Binary archive files are placed in <filename>${prefix}/var/macports/software/</filename>. The archive
- file type is set in the <filename>macports.conf</filename> file using the
+ file type is set in <filename>macports.conf</filename> using the
<option>portarchivetype</option> key. The default format is <option>tbz2</option>; other options are:
<option>tar</option>, <option>tbz</option>, <option>tbz2</option>, <option>tgz</option>,
<option>tlz</option>, <option>txz</option>, <option>xar</option>, <option>zip</option>,
@@ -1514,7 +1513,7 @@
to users without relying on MacPorts for installation. Binary installers created with MacPorts are
usually <option>.pkg</option> (OS X Installer Packages). MacPorts can also convert
a <option>.pkg</option> package into an OS X <option>.dmg</option> disk image. You can create binary
- packages with the <command>port</command> command as shown in the following examples.</para>
+ packages using <command>port</command> as shown in the following examples.</para>
<warning>
<para>If you want to create installer packages using MacPorts for redistribution, make sure you do not
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20150330/a57329b0/attachment-0001.html>
More information about the macports-changes
mailing list