[105189] trunk/doc-new/guide/xml
ryandesign at macports.org
ryandesign at macports.org
Fri Apr 12 18:09:56 PDT 2013
Revision: 105189
https://trac.macports.org/changeset/105189
Author: ryandesign at macports.org
Date: 2013-04-12 18:09:55 -0700 (Fri, 12 Apr 2013)
Log Message:
-----------
use "quote" tag so we get smart quotes; fix some other tags
Modified Paths:
--------------
trunk/doc-new/guide/xml/installing.xml
trunk/doc-new/guide/xml/internals.xml
trunk/doc-new/guide/xml/macports.conf.xml
trunk/doc-new/guide/xml/portfile-dependencies.xml
trunk/doc-new/guide/xml/portfile-keywords.xml
trunk/doc-new/guide/xml/portfile-livecheck.xml
trunk/doc-new/guide/xml/portfile-phase.xml
trunk/doc-new/guide/xml/portfile-startupitem.xml
trunk/doc-new/guide/xml/portfile-tcl.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/installing.xml
===================================================================
--- trunk/doc-new/guide/xml/installing.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/installing.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -141,8 +141,8 @@
</para>
<para>
If you wish to create Installer packages with <userinput>port pkg</userinput>,
- you will also need to install PackageMaker, which is in the "Auxiliary
- Tools for Xcode" package as of Xcode 4.3. The download page for this package
+ you will also need to install PackageMaker, which is in the <quote>Auxiliary
+ Tools for Xcode</quote> package as of Xcode 4.3. The download page for this package
can be opened via the Xcode -> Open Developer Tool -> More Developer Tools...
menu item. After downloading and mounting the disk image, drag the PackageMaker
application to your /Applications directory.
Modified: trunk/doc-new/guide/xml/internals.xml
===================================================================
--- trunk/doc-new/guide/xml/internals.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/internals.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -27,7 +27,7 @@
version.</para>
<para>This capability derives from the fact that a MacPorts port by
- default is not installed into its final or "activated" location, but
+ default is not installed into its final or <quote>activated</quote> location, but
rather to an intermediate location that is only made available to other
ports and end-users after an activation phase that extracts all
its files from the image repository. Deactivating a port
@@ -68,7 +68,7 @@
<filename>base/src/port1.0</filename>. The Port API provides all the
primitives required for a Portfile to be parsed, queried, and executed.
It also provides a single procedure call that the MacPorts API uses to
- kick off execution: "eval_targets". The port Tcl library supplies these
+ kick off execution: <code>eval_targets</code>. The port Tcl library supplies these
procedures, all of which are generated at run-time using the
<code>options</code> procedure in portutil.tcl.</para>
@@ -254,7 +254,7 @@
<itemizedlist>
<listitem>
<para>Calls the <code>mportsearch</code> function to find all ports
- containing "cm3".</para>
+ containing <quote>cm3</quote>.</para>
</listitem>
<listitem>
@@ -275,7 +275,7 @@
<itemizedlist>
<listitem>
<para>Calls the <code>mportsearch</code> function to find the first
- port that matches the name "cm3".</para>
+ port that matches the name <quote>cm3</quote>.</para>
</listitem>
<listitem>
Modified: trunk/doc-new/guide/xml/macports.conf.xml
===================================================================
--- trunk/doc-new/guide/xml/macports.conf.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/macports.conf.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -198,8 +198,8 @@
<listitem>
<para>Number of simultaneous make jobs (commands) to use when
- building ports. Using "0" will cause a runtime autodetection to use
- all available processor cores.</para>
+ building ports. Using <quote>0</quote> will cause a runtime
+ autodetection to use all available processor cores.</para>
<para>Default: 0</para>
</listitem>
@@ -209,8 +209,8 @@
<term>portautoclean</term>
<listitem>
- <para>Set whether to automatically execute "clean" after "install"
- of ports.</para>
+ <para>Set whether to automatically execute <quote>clean</quote> after
+ <quote>install</quote> of ports.</para>
<para>Default: <option>yes</option></para>
</listitem>
@@ -305,10 +305,11 @@
<listitem>
<para>Options for generated startup items, though this may be
- overridden by the "startupitem.type" Portfile key. Options are
- "default" option, "SystemStarter", "launchd", or "none". For an
- empty or "default" option, a startupitem type appropriate to the
- platform is used; if "none", no port startupitems are
+ overridden by the <code>startupitem.type</code> Portfile key. Options
+ are <quote>default</quote> option, <quote>SystemStarter</quote>,
+ <quote>launchd</quote>, or <quote>none</quote>. For an empty or
+ <quote>default</quote> option, a startupitem type appropriate to the
+ platform is used; if <quote>none</quote>, no port startupitems are
installed.</para>
<para>Default: <option>default</option></para>
@@ -337,7 +338,7 @@
<term>place_worksymlink</term>
<listitem>
- <para>Set whether to place a symlink named "work" from your ports tree to
+ <para>Set whether to place a symlink named <quote>work</quote> from your ports tree to
the build directory of a port, when the port is being built. This
is convenient, but may not be ideal if you care about the structure
of your ports tree. For example, some developers keep their ports
Modified: trunk/doc-new/guide/xml/portfile-dependencies.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-dependencies.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-dependencies.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -120,9 +120,11 @@
<para>But when satisfying a dependency with vendor-supplied software is
preferred for special reasons, or when it is possible for more than one
port to satisfy a dependency, then file dependencies may be used. An
- example of the former is with X11 —Apple's is widely preferred; an example
- of the latter is with "-devel" named ports —these ports provide identical
- files (though only one can be activated at a time).</para>
+ example of the former is with ubiquitous utilities like awk, grep, make or
+ sed, where OS X's versions are often sufficient; an example of the latter
+ is with <quote>-devel</quote> ports—these ports provide a different
+ version of the same files (though only one can be activated at a
+ time).</para>
<para>Port dependencies, the preferred type, are specified as shown in
these examples:</para>
Modified: trunk/doc-new/guide/xml/portfile-keywords.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-keywords.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-keywords.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -6,9 +6,9 @@
<para>MacPorts keywords are used to specify required or optional items
within a Portfile, or to override default options used by MacPorts base for
- individual ports. Keywords are to be used within the "global" and "variant"
- sections of Portfiles, and not within optional port phase
- declarations.</para>
+ individual ports. Keywords are to be used within the <quote>global</quote>
+ and <quote>variant</quote> sections of Portfiles, and not within optional
+ port phase declarations.</para>
<para>The global keywords listed below specify information for ports as a
whole, whereas the keywords listed under a port phase specify information to
@@ -37,8 +37,8 @@
<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
- "+" characters, change these to "x" (i.e. "libstdc++" becomes
- "libstdcxx").</para>
+ <quote>+</quote> characters, change these to <quote>x</quote> (i.e.
+ <quote>libstdc++</quote> becomes <quote>libstdcxx</quote>).</para>
<programlisting>name foo</programlisting>
</listitem>
Modified: trunk/doc-new/guide/xml/portfile-livecheck.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-livecheck.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-livecheck.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -93,7 +93,7 @@
release. For googlecode releases use the name of the file download,
including extension. You may use this keyword without
<code>livecheck.version</code> if you replace the version part of
- the name with "<literal>(.*)</literal>".</para>
+ the name with <quote><literal>(.*)</literal></quote>.</para>
<itemizedlist>
<listitem>
Modified: trunk/doc-new/guide/xml/portfile-phase.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-phase.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-phase.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -105,9 +105,10 @@
</note>
<para>Understanding the destroot phase is critical to understanding
- MacPorts, because, unlike some port systems, MacPorts "stages" an
- installation into an intermediate location —not the final file
- destination. MacPorts uses the destroot phase to provide:</para>
+ MacPorts, because, unlike some package management systems, MacPorts
+ <quote>stages</quote> an installation into an intermediate location,
+ not the final file destination. MacPorts uses the destroot phase to
+ provide:</para>
<itemizedlist>
<listitem>
@@ -162,9 +163,9 @@
<para>MacPorts keywords are used to specify required or optional items
within a Portfile, or to override default options used by MacPorts base
- for individual ports. Keywords are to be used within the "global" and
- "variant" sections of Portfiles, and not within optional port phase
- declarations.</para>
+ for individual ports. Keywords are to be used within the
+ <quote>global</quote> and <quote>variant</quote> sections of Portfiles,
+ and not within optional port phase declarations.</para>
<para>In other words, port phase keywords are not located within port
phase declarations, but rather they <emphasis>refer</emphasis> to port
Modified: trunk/doc-new/guide/xml/portfile-startupitem.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-startupitem.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-startupitem.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -4,7 +4,7 @@
<section id="reference.startupitems">
<title>StartupItems</title>
- <para>A StartupItem is a MacPorts facility to run "daemons," a Unix term for
+ <para>A StartupItem is a MacPorts facility to run <quote>daemons,</quote> a Unix term for
programs that run continuously in the background, rather than under the
direct control of a user; for example, mail servers, network listeners, etc.
Ports that use StartupItem keywords create Mac OS X scripts for <ulink
@@ -180,7 +180,7 @@
arbitrary shell code may not be used.</para>
<note>
- <para>Some daemons "daemonize" by detaching themselves from the
+ <para>Some daemons <quote>daemonize</quote> by detaching themselves from the
controlling tty before sending themselves to the background, thus
making themselves a child of the original process. A daemon to be
started with <code>startupitem.executable</code> must not be
Modified: trunk/doc-new/guide/xml/portfile-tcl.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-tcl.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-tcl.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -72,7 +72,7 @@
<term>copy</term>
<listitem>
- <para>Shorthand alternative to "file copy".</para>
+ <para>Shorthand alternative to <code>file copy</code>.</para>
</listitem>
</varlistentry>
</variablelist>
@@ -82,7 +82,7 @@
<term>move</term>
<listitem>
- <para>Shorthand alternative to "file rename".</para>
+ <para>Shorthand alternative to <code>file rename</code>.</para>
</listitem>
</varlistentry>
Modified: trunk/doc-new/guide/xml/portfile-variables.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-variables.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-variables.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -133,7 +133,9 @@
<term>os.platform</term>
<listitem>
- <para>The underlying operating system platform (i.e. "darwin" on Mac OS X, "freebsd", etc.).</para>
+ <para>The underlying operating system platform (i.e.
+ <quote>darwin</quote> on OS X, <quote>freebsd</quote>,
+ etc.).</para>
</listitem>
</varlistentry>
@@ -141,7 +143,8 @@
<term>os.arch</term>
<listitem>
- <para>The hardware architecture -- either "powerpc" or "i386".</para>
+ <para>The hardware architecture -- either <quote>powerpc</quote> or
+ <quote>i386</quote>.</para>
</listitem>
</varlistentry>
@@ -149,8 +152,8 @@
<term>os.version</term>
<listitem>
- <para>The version number of the host operating system (i.e. "8.11.0" for
- Darwin 8.11.0 a.k.a. Mac OS X 10.4.11).</para>
+ <para>The version number of the host operating system (i.e.
+ <quote>12.3.0</quote> for Darwin 12.3.0 a.k.a. OS X 10.8.3).</para>
</listitem>
</varlistentry>
@@ -158,7 +161,8 @@
<term>os.endian</term>
<listitem>
- <para>Endianness of the processor -- either "big" (on PowerPC systems) or "little" (on Intel systems).</para>
+ <para>Endianness of the processor -- either <quote>big</quote> (on
+ PowerPC systems) or <quote>little</quote> (on Intel systems).</para>
</listitem>
</varlistentry>
@@ -166,8 +170,8 @@
<term>os.major</term>
<listitem>
- <para>The major version number of the host operating system (i.e. "8"
- for Darwin 8.x).</para>
+ <para>The major version number of the host operating system (i.e.
+ <quote>12</quote> for Darwin 12.x).</para>
</listitem>
</varlistentry>
</variablelist>
Modified: trunk/doc-new/guide/xml/portfile-variants.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-variants.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfile-variants.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -41,8 +41,8 @@
<literal>variant_isset</literal> conditional within a phase
declaration and not within the variant declaration itself.
Dependencies and conflicts with other variants in the same port can
- be expressed with <quote>requires</quote> and
- <quote>conflicts</quote> options as shown below.</para>
+ be expressed with <literal>requires</literal> and
+ <literal>conflicts</literal> options as shown below.</para>
<itemizedlist>
<listitem>
@@ -90,7 +90,7 @@
</itemizedlist>
<para>Default variants may be suppressed by preceding a variant name
- with a "-" as shown in this example.</para>
+ with a <quote>-</quote> as shown in this example.</para>
<programlisting><prompt>%%</prompt> <userinput>port install foo -ssl</userinput></programlisting>
</listitem>
@@ -127,8 +127,8 @@
<title>User-Selected Variant Descriptions</title>
<para>User-selected variants ought to provide a description, which will be
- displayed when using command <quote>port variants foo</quote>. The syntax
- used for the description keyword is shown below.</para>
+ displayed when using command <userinput>port variants foo</userinput>. The
+ syntax used for the description keyword is shown below.</para>
<programlisting>variant bar description {Add IMAP support} {}</programlisting>
@@ -137,9 +137,10 @@
support, a good rule of thumb is to use sentence fragments for brevity,
with a capitalized first letter and no trailing punctuation. Think of them
as short labels such as ones you'd find next to a GUI checkbox or radio
- button. Thus, it would be better to write "Build with support for foo"
- instead of "Builds with support for foo"; "Add support for foo" would be
- better than "Adds support for foo". </para>
+ button. Thus, it would be better to write <quote>Build with support for
+ foo</quote> instead of <quote>Builds with support for foo</quote>;
+ <quote>Add support for foo</quote> would be better than <quote>Adds support
+ for foo</quote>.</para>
<para>Variant descriptions are strings, so one should take care not to put
whitespace between the brackets and the beginning and end of the variant
Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portfiledev.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -24,12 +24,12 @@
<para>A common way for Portfiles to augment or override MacPorts base
default installation phase characteristics is by using
<filename>Portfile</filename> phase declaration(s). If you use Portfile
- phase declaration(s), you should know how to identify the "global" section
- of a Portfile. Any statements not contained within a phase declaration, no
- matter where they are located in a Portfile, are said to be in the global
- section of the Portfile; therefore the global section need not be
- contiguous. Likewise, to remove statements from the global section they
- must be placed within a phase declaration.</para>
+ phase declaration(s), you should know how to identify the
+ <quote>global</quote> section of a Portfile. Any statements not contained
+ within a phase declaration, no matter where they are located in a Portfile,
+ are said to be in the global section of the Portfile; therefore the global
+ section need not be contiguous. Likewise, to remove statements from the
+ global section they must be placed within a phase declaration.</para>
<para>The main phases you need to be aware of when making a Portfile are
these:</para>
@@ -387,7 +387,7 @@
<para>Variants are a way for port authors to provide options that may be
invoked at install time. They are declared in the global section of a
- Portfile using the "variant" keyword, and should include <link
+ Portfile using the <quote>variant</quote> keyword, and should include <link
linkend="reference.variants.descriptions">carefully chosen variant
descriptions</link>.</para>
@@ -525,17 +525,17 @@
<listitem>
<para>Now use the Unix command <command>diff -u </command>to create
- a "unified" diff patch file. Put the name of the port in the
- patchfile, for example, Portfile-rrdtool.diff.</para>
+ a <quote>unified</quote> diff patch file. Put the name of the port in
+ the patchfile, for example, Portfile-rrdtool.diff.</para>
<programlisting><prompt>%%</prompt> <userinput>diff -u Portfile.orig Portfile > Portfile-rrdtool.diff</userinput></programlisting>
</listitem>
<listitem>
- <para>A patch file that is a "unified" diff file is the easiest to
- interpret by humans and this type should always be used for ports.
- The Portfile patch below will change the version and checksums when
- applied.</para>
+ <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. The Portfile patch below will change the version and
+ checksums when applied.</para>
<programlisting>--- Portfile.orig 2011-07-25 18:52:12.000000000 -0700
+++ Portfile 2011-07-25 18:53:35.000000000 -0700
@@ -617,7 +617,7 @@
<listitem>
<para>Now <command>cd</command> to the top-level directory of the
unpacked source, and use the Unix command <command>diff -u</command>
- to create a "unified" diff patch file.</para>
+ to create a <quote>unified</quote> diff patch file.</para>
<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>
@@ -643,10 +643,11 @@
</listitem>
<listitem>
- <para>A patch file that is a "unified" 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>
+ <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>
<programlisting>--- src/Makefile.in.orig 2007-06-01 16:30:47.000000000 -0700
+++ src/Makefile.in 2007-06-20 10:10:59.000000000 -0700
@@ -742,8 +743,8 @@
matches the port, which should in turn be placed inside a directory
that reflects the port's primary category (the first category entry in
the Portfile). For example, to create the directory for a hypothetical
- port "bestevergame" and to begin editing its Portfile in TextEdit, you
- can use these commands:</para>
+ port <quote>bestevergame</quote> and to begin editing its Portfile in
+ TextEdit, you can use these commands:</para>
<programlisting><prompt>%%</prompt> <userinput>mkdir -p ~/ports/games/bestevergame</userinput>
<prompt>%%</prompt> <userinput>cd ~/ports/games/bestevergame</userinput>
@@ -822,11 +823,11 @@
<para>Frequently multiple items are necessary in the second column. For
example, to set multiple source download locations, multiple
- "master_sites" must be defined. Unless the second column items are few
- and short you should place each additional item on a new line and
- separate lines with a backslash. Indent the lines after the first line
- to make it clear the items are second column values and also to
- emphasize the unity of the block.</para>
+ <code>master_sites</code> must be defined. Unless the second column
+ items are few and short you should place each additional item on a new
+ line and separate lines with a backslash. Indent the lines after the
+ first line to make it clear the items are second column values and also
+ to emphasize the unity of the block.</para>
<programlisting>destroot.keepdirs ${destroot}${prefix}/var/run \
${destroot}${prefix}/var/log \
@@ -865,13 +866,13 @@
<para>If there is the need to replace a port with another port or a
renaming is necessary for some reason, the port should be marked as
- <quote>replaced_by</quote>.</para>
+ <code>replaced_by</code>.</para>
- <para>As an illustration of a typical workflow the port 'skrooge-devel'
- shall be taken. This port had been used for testing new versions of
- skrooge, but it turned out to have become unnecessary due to the fact
- that skrooge's developers currently prefer a distribution via port
- 'skrooge' instead. </para>
+ <para>As an illustration of a typical workflow the port
+ <quote>skrooge-devel</quote> shall be taken. This port had been used for
+ testing new versions of skrooge, but it turned out to have become
+ unnecessary due to the fact that skrooge's developers currently prefer a
+ distribution via port <quote>skrooge</quote> instead. </para>
<para>Skrooge's original devel port file looked like this:</para>
@@ -915,11 +916,11 @@
<para>The following steps have to be taken to ensure a smooth transition
for a MacPorts user updating his local installation using
- <quote>sudo port upgrade</quote>:</para>
+ <userinput>sudo port upgrade</userinput>:</para>
<orderedlist>
<listitem>
- <para> add the line <quote>replaced_by foo</quote> where foo is the
+ <para> add the line <code>replaced_by foo</code> where foo is the
port this one is replaced by; when a user upgrades this port,
MacPorts will instead install the replacement port</para>
<programlisting>replaced_by skrooge</programlisting>
@@ -927,15 +928,15 @@
<listitem>
<para> increase the version, revision, or epoch, so that users who
- have this port installed will get notice in <quote>port
- outdated</quote> that they should upgrade it and trigger the above
+ have this port installed will get notice in <code>port
+ outdated</code> that they should upgrade it and trigger the above
process</para>
<programlisting>revision 1</programlisting>
</listitem>
<listitem>
<para> clear distfiles (have a line reading only
- <quote>distfiles</quote>) so that no distfile is downloaded for this
+ <code>distfiles</code>) so that no distfile is downloaded for this
stub port</para>
<programlisting>distfiles</programlisting>
</listitem>
@@ -951,8 +952,8 @@
</listitem>
<listitem>
- <para> add a pre-configure block with a <quote>ui_error</quote> and
- <quote>return -code error</quote> explaining to users who try to
+ <para> add a pre-configure block with a <code>ui_error</code> and
+ <code>return -code error</code> explaining to users who try to
install this port that the port has been replaced</para>
<programlisting>pre-configure {
ui_error "Please do not install this port since it has been replaced by 'skrooge'."
@@ -997,8 +998,8 @@
distfiles</programlisting>
- <para>A user upgrading ports will experience for port 'skrooge-devel'
- the following:</para>
+ <para>A user upgrading ports will experience the following for port
+ <quote>skrooge-devel</quote>:</para>
<programlisting><prompt>%%</prompt> <userinput>sudo port upgrade skrooge-devel</userinput></programlisting>
<screen>---> skrooge-devel is replaced by skrooge
---> Computing dependencies for skrooge
@@ -1028,8 +1029,8 @@
---> Cleaning skrooge</screen>
<para>In case a user actually tries to install the obsolete port
- 'skrooge-devel' it would be pointed out by an error message that this is
- impossible now:</para>
+ <quote>skrooge-devel</quote> it would be pointed out by an error message that
+ this is impossible now:</para>
<programlisting><prompt>%%</prompt> <userinput>sudo port install skrooge-devel</userinput></programlisting>
<screen>---> Fetching skrooge-devel
---> Verifying checksum(s) for skrooge-devel
Modified: trunk/doc-new/guide/xml/portgroup-python.xml
===================================================================
--- trunk/doc-new/guide/xml/portgroup-python.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/portgroup-python.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -29,16 +29,16 @@
<listitem>
<para>Defines the python versions supported by this port. If the
- port name starts with "py-", then a subport will be defined for each
- version in the list. For example, if a port named "py-foo" declares
- "python.versions 26 27", subports "py26-foo" and "py27-foo" will be
+ port name starts with <quote>py-</quote>, then a subport will be defined for each
+ version in the list. For example, if a port named <quote>py-foo</quote> declares
+ <code>python.versions 26 27</code>, subports <quote>py26-foo</quote> and <quote>py27-foo</quote> will be
created, and will depend on python26 and python27 respectively.</para>
- <para>If the port name does not start with "py-", it is interpreted
+ <para>If the port name does not start with <quote>py-</quote>, it is interpreted
as an application written in python rather than a python module. In
- this case, no subports are defined, and python.versions defaults to
- the value of python.default_version, which must be set. For example,
- if a port named "mercurial" sets "python.default_version 27", then
- python.versions will automatically be set to "27", and a dependency
+ this case, no subports are defined, and <code>python.versions</code> defaults to
+ the value of <code>python.default_version</code>, which must be set. For example,
+ if a port named <quote>mercurial</quote> sets <code>python.default_version 27</code>, then
+ <code>python.versions</code> will automatically be set to <quote>27</quote>, and a dependency
on python27 will be added.</para>
<itemizedlist>
@@ -57,11 +57,11 @@
<term>python.default_version</term>
<listitem>
- <para>For modules (i.e. name starts with "py-"), this sets the
- subport that will be installed if the user asks to install "py-foo"
- rather than e.g. "py26-foo" or "py27-foo". If not explicitly set, a
- reasonable default is chosen from the list in python.versions.</para>
- <para>For apps (i.e. name does not start with "py-"), this chooses
+ <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
+ 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
which version of python to use, and must be set. It can be changed
in variants if desired.</para>
@@ -81,7 +81,7 @@
<term>python.link_binaries</term>
<listitem>
- <para>When yes (the default), tells the PortGroup to automatically
+ <para>When <quote>yes</quote> (the default), tells the PortGroup to automatically
link any executable binaries installed in the bin/ directory within
the framework into
<filename>${prefix}/bin</filename>.</para>
@@ -122,7 +122,7 @@
<para>When yes (the default), the PortGroup will automatically
try to pass the correct arch-specific flags during build time
(via the standard CFLAGS, LDFLAGS, etc environment variables).
- Set this to no and setup those variables in build.env manually
+ Set this to <quote>no</quote> and set up those variables in <code>build.env</code> manually
if the default does not work.</para>
<itemizedlist>
<listitem>
@@ -151,7 +151,7 @@
<listitem>
<para>The python version in use in the current subport. This will be
- one of the versions listed in python.versions.</para>
+ one of the versions listed in <code>python.versions</code>.</para>
</listitem>
</varlistentry>
@@ -160,8 +160,8 @@
<listitem>
<para>The python version in use in the current subport, in normal
- dotted notation. For example, if python.version is "26",
- python.branch will be "2.6".</para>
+ dotted notation. For example, if <code>python.version</code> is <quote>26</quote>,
+ <code>python.branch</code> will be <quote>2.6</quote>.</para>
</listitem>
</varlistentry>
Modified: trunk/doc-new/guide/xml/project.xml
===================================================================
--- trunk/doc-new/guide/xml/project.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/project.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -28,9 +28,10 @@
new problems, and even if it doesn't, it means that log messages
from earlier steps, which can be essential for figuring out why a
build failed, are not included in the new log; MacPorts prints
- "Skipping completed" in the log for each previously-completed phase
- that was skipped. Before filing a ticket, "sudo port clean" the
- port that failed, then try again.
+ <quote>Skipping completed</quote> in the log for each
+ previously-completed phase that was skipped. Before filing a
+ ticket, <userinput>sudo port clean</userinput> the port that
+ failed, then try again.
</para>
</listitem>
<listitem>
@@ -59,7 +60,7 @@
<para>Is the problem an application error and not related to compiling and installing?</para>
<para>
In general, application bugs should be reported to the developers of the app
- ("upstream"), not MacPorts. An application bug that affects a large number of
+ (<quote>upstream</quote>), not MacPorts. An application bug that affects a large number of
MacPorts users might merit a MacPorts bug for informational purposes only, but
this should be done sparingly.
</para>
@@ -84,8 +85,8 @@
will be presented with a new ticket window shown in the graphic below.
Follow the Trac ticket guidelines below to fill out the form. If you are
reporting a failed port install and a log was mentioned in the error,
- please use the "I have files to attach to this ticket" checkbox to add
- that log file to the ticket.</para>
+ please use the <guilabel>I have files to attach to this ticket</guilabel>
+ checkbox to add that log file to the ticket.</para>
<screenshot>
<screeninfo>A new Trac ticket</screeninfo>
@@ -144,8 +145,8 @@
what's really relevant to the report, as otherwise overly large
ticket pages can become unmanageable. Long output, such as the
full log from a port build, should be added as an attachment, not
- pasted inline. See "I have files to attach to this ticket" below.
- </para>
+ pasted inline. See <guilabel>I have files to attach to this
+ ticket</guilabel> below.</para>
</listitem>
@@ -267,10 +268,11 @@
<para><guilabel>Keywords:</guilabel> Type any keywords that might
help when searching for tickets. It is not useful to list words here
that already appear elsewhere in the ticket. Keywords also serve as
- tags; for example, use "tiger" if reporting a bug that only
- affects OS X 10.4, "haspatch" if a fix is attached to the ticket,
- "maintainer" if you are the port's maintainer, or "LP64" if
- reporting an issue that only affects 64-bit platforms.</para>
+ tags; for example, use <quote>tiger</quote> if reporting a bug that
+ only affects OS X 10.4, <quote>haspatch</quote> if a fix is attached
+ to the ticket, <quote>maintainer</quote> if you are the port's
+ maintainer, or <quote>LP64</quote> if reporting an issue that only
+ affects 64-bit platforms.</para>
</listitem>
<listitem>
Modified: trunk/doc-new/guide/xml/using.xml
===================================================================
--- trunk/doc-new/guide/xml/using.xml 2013-04-13 00:20:47 UTC (rev 105188)
+++ trunk/doc-new/guide/xml/using.xml 2013-04-13 01:09:55 UTC (rev 105189)
@@ -445,7 +445,7 @@
linkend="development.variants">Port Variants</link>. Default variants
are optional, and not all ports using variants have them. For ports with
default variants, you may install a port without them by negating
- default variants using "-" as shown.</para>
+ default variants using <quote>-</quote> as shown.</para>
<programlisting><prompt>%%</prompt> <userinput>sudo port install fetchmail -ssl</userinput></programlisting>
@@ -688,7 +688,7 @@
<programlisting><prompt>%%</prompt> <userinput>port installed requested</userinput></programlisting>
<para>Checking the list of leaves from time to time will help to keep your system
- free of too much "garbage". However, keep in mind that some ports may be dependencies
+ free of too much <quote>garbage</quote>. However, keep in mind that some ports may be dependencies
only during the installation of a port (library dependencies, installation or
configuration tools, etc.). So, be careful when removing seemingly unnecessary leaves,
otherwise you'll see them being installed again and again.</para>
@@ -779,7 +779,7 @@
<programlisting><prompt>%%</prompt> <userinput>sudo port rpm pstree</userinput></programlisting>
<para>All packages are placed in a port's work directory,
- except for rpms that are placed under the regular "RPMS":</para>
+ except for rpms that are placed under the regular <quote>RPMS</quote>:</para>
<programlisting><prompt>%%</prompt> <userinput>port work pstree</userinput></programlisting>
<programlisting><prompt>%%</prompt> <userinput>rpm --eval %{_rpmdir}</userinput></programlisting>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20130412/e55a8182/attachment-0001.html>
More information about the macports-changes
mailing list