[28261] trunk/doc/guide/new/xml
source_changes at macosforge.org
source_changes at macosforge.org
Sun Aug 26 14:25:25 PDT 2007
Revision: 28261
http://trac.macosforge.org/projects/macports/changeset/28261
Author: markd at macports.org
Date: 2007-08-26 14:25:25 -0700 (Sun, 26 Aug 2007)
Log Message:
-----------
Shorten section IDs, thereby shortening urls within the guide. Thanks to simonr for the
patches.
Modified Paths:
--------------
trunk/doc/guide/new/xml/installing.xml
trunk/doc/guide/new/xml/internals.xml
trunk/doc/guide/new/xml/intro.xml
trunk/doc/guide/new/xml/portfiledev.xml
trunk/doc/guide/new/xml/portfileref.xml
trunk/doc/guide/new/xml/project.xml
trunk/doc/guide/new/xml/using.xml
Modified: trunk/doc/guide/new/xml/installing.xml
===================================================================
--- trunk/doc/guide/new/xml/installing.xml 2007-08-26 19:36:08 UTC (rev 28260)
+++ trunk/doc/guide/new/xml/installing.xml 2007-08-26 21:25:25 UTC (rev 28261)
@@ -1,17 +1,16 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="installing-macports">
+<chapter id="installing">
<title>Installing MacPorts</title>
<para>This chapter show you how to install MacPorts and its prerequistes
step-by-step. Note that sections 1 through 3 are Mac OS X specific. If you
wish to install MacPorts on FreeBSD, first make sure you have gcc and X11
installed, and then begin with section <link
- linkend="installing-macports.install.macports.source">Install MacPorts -
- Source</link>.</para>
+ linkend="installing.source">Install MacPorts - Source</link>.</para>
- <section id="installing-macports.install.xcode.tools">
+ <section id="installing.xcode">
<title>Install Xcode Tools</title>
<para>To install Xcode Tools and the X11 SDK, follow these steps.</para>
@@ -45,7 +44,7 @@
</note>
</section>
- <section id="installing-macports.install.x11">
+ <section id="installing.x11">
<title>Install X11</title>
<para>On OS X 10.4, Apple's X Window System (X11) is an optional install
@@ -82,7 +81,7 @@
<filename>/Library/Receipts/</filename>.</para>
</note>
- <section>
+ <section id="installing.x11.settings">
<title>Optional X11 Settings</title>
<para>To launch X11 applications directly from an X11 window (instead of
@@ -118,15 +117,14 @@
</section>
</section>
- <section id="installing-macports.install.macports.binary">
+ <section id="installing.binary">
<title>Install MacPorts - Binary</title>
<para>If you wish to install MacPorts to a path other than
<filename>/opt/local</filename> do not install the MacPorts binary —skip
- this section and <link
- linkend="installing-macports.install.macports.source">install MacPorts
- from the source code</link>. The MacPorts binary installer will only
- install to <filename>/opt/local</filename>.</para>
+ this section and <link linkend="installing.source">install MacPorts from
+ the source code</link>. The MacPorts binary installer will only install to
+ <filename>/opt/local</filename>.</para>
<orderedlist>
<listitem>
@@ -145,14 +143,13 @@
</orderedlist>
<note>
- <para>A MacPorts <link
- linkend="installing-macports.selfupdate">selfupdate</link> operation
- will automatically update to the latest release if the binary .dmg image
- is behind the latest released tarball.</para>
+ <para>A MacPorts <link linkend="installing.selfupdate">selfupdate</link>
+ operation will automatically update to the latest release if the binary
+ .dmg image is behind the latest released tarball.</para>
</note>
</section>
- <section id="installing-macports.install.macports.source">
+ <section id="installing.source">
<title>Install MacPorts - Source</title>
<para>If you installed MacPorts using the binary installer, skip this
@@ -180,14 +177,13 @@
</orderedlist>
<note>
- <para>A MacPorts <link
- linkend="installing-macports.selfupdate">selfupdate</link> operation
- will automatically update to the latest release if the binary .dmg image
- is behind the latest released tarball.</para>
+ <para>A MacPorts <link linkend="installing.selfupdate">selfupdate</link>
+ operation will automatically update to the latest release if the binary
+ .dmg image is behind the latest released tarball.</para>
</note>
</section>
- <section id="installing-macports.set.bash.shell">
+ <section id="installing.shell">
<title>Set the Bash Shell</title>
<para>The MacPorts binary installer places a <filename>.profile</filename>
@@ -244,13 +240,12 @@
</note>
</section>
- <section id="installing-macports.selfupdate">
+ <section id="installing.selfupdate">
<title>MacPorts Selfupdate</title>
<para>You must always do a selfupdate after a new MacPorts install, and
you should also do it frequently thereafter. See <link
- linkend="using-macports.port.command.selfupdate">selfupdate</link> —one of
- several <link linkend="using-macports.port.command">port
- commands</link>.</para>
+ linkend="using.port.selfupdate">selfupdate</link> —one of several <link
+ linkend="using.port">port commands</link>.</para>
</section>
</chapter>
\ No newline at end of file
Modified: trunk/doc/guide/new/xml/internals.xml
===================================================================
--- trunk/doc/guide/new/xml/internals.xml 2007-08-26 19:36:08 UTC (rev 28260)
+++ trunk/doc/guide/new/xml/internals.xml 2007-08-26 21:25:25 UTC (rev 28261)
@@ -1,13 +1,13 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="macports-internals">
+<chapter id="internals">
<title>MacPorts Internals</title>
<para>This chapter contains information to help gain a better understanding
of MacPorts or learn how to configure it for non-default operation.</para>
- <section id="macports-internals.macports.file.hierarchy">
+ <section id="internals.hierarchy">
<title>MacPorts File Hierarchy</title>
<para>MacPorts port authors install files according to guidelines that
@@ -240,7 +240,7 @@
</variablelist>
</section>
- <section id="macports-internals.configuration.files">
+ <section id="internals.configuration-files">
<title>Configuration Files</title>
<para>The MacPorts configuration files do not need to be modified for the
@@ -248,7 +248,7 @@
users and port developers. All the MacPorts configuration files are
located in <filename>/opt/local/etc/macports</filename>.</para>
- <section id="macports-internals.configuration.files.sources.conf">
+ <section id="internals.configuration-files.sources-conf">
<title>sources.conf</title>
<para><filename>sources.conf</filename> is where the location(s) are set
@@ -256,14 +256,14 @@
local Portfile repository.</para>
</section>
- <section id="macports-internals.configuration.files.macports.conf">
+ <section id="internals.configuration-files.macports-conf">
<title>macports.conf</title>
<para><filename>macports.conf</filename> contains advanced MacPorts
configuration options. See the file comments for instructions.</para>
</section>
- <section id="macports-internals.configuration.files.variants.conf">
+ <section id="internals.configuration-files.variants-conf">
<title>variants.conf</title>
<para><filename>variants.conf</filename> is used to specify variants to
@@ -271,7 +271,7 @@
</section>
</section>
- <section id="macports-internals.port.images">
+ <section id="internals.images">
<title>Port Images</title>
<para>MacPorts has a unique ability to allow for multiple versions,
@@ -297,7 +297,7 @@
</note>
</section>
- <section id="macports-internals.macports.apis">
+ <section id="internals.apis">
<title>MacPorts APIs</title>
<para>MacPorts contains two application programming interfaces (APIs),
@@ -305,7 +305,7 @@
an internal API used for individual Portfiles. The latter is a high-level
API used by client applications such as the MacPorts port utility.</para>
- <section id="macports-internals.macports.apis.ports">
+ <section id="internals.apis.ports">
<title>Ports API</title>
<para>The code for the Port API is located in
@@ -349,7 +349,7 @@
</itemizedlist>
</section>
- <section id="macports-internals.macports.apis.macports">
+ <section id="internals.apis.macports">
<title>MacPorts API</title>
<para>The code for the MacPorts API is located in
@@ -492,7 +492,7 @@
</section>
</section>
- <section id="macports-internals.macports.registry">
+ <section id="internals.registry">
<title>The MacPorts Registry</title>
<para>This chapter provides an overview of the MacPorts registry and its
@@ -521,7 +521,7 @@
</listitem>
</itemizedlist>
- <section id="macports-internals.macports.registry.registry.files">
+ <section id="internals.registry.files">
<title>Registry Files</title>
<para>The flat file registry (MacPorts default registry) files are
@@ -542,7 +542,7 @@
</itemizedlist>
</section>
- <section id="macports-internals.macports.registry.registry.api">
+ <section id="internals.registry.api">
<title>The Registry API</title>
<para>The MacPorts Registry provides a public API in the registry1.0 Tcl
Modified: trunk/doc/guide/new/xml/intro.xml
===================================================================
--- trunk/doc/guide/new/xml/intro.xml 2007-08-26 19:36:08 UTC (rev 28260)
+++ trunk/doc/guide/new/xml/intro.xml 2007-08-26 21:25:25 UTC (rev 28261)
@@ -45,7 +45,7 @@
portable so it can work on other Unix-like systems, especially those
descended from the Berkeley Software Distribution (BSD).</para>
- <section>
+ <section id="introduction.conventions">
<title>Document Conventions</title>
<para>The MacPorts Guide uses some notational conventions to distinguish
Modified: trunk/doc/guide/new/xml/portfiledev.xml
===================================================================
--- trunk/doc/guide/new/xml/portfiledev.xml 2007-08-26 19:36:08 UTC (rev 28260)
+++ trunk/doc/guide/new/xml/portfiledev.xml 2007-08-26 21:25:25 UTC (rev 28261)
@@ -1,24 +1,23 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="portfile-development">
+<chapter id="development">
<title>Portfile Development</title>
<para>This chapter covers a brief introduction to Portfiles, how to create a
local Portfile repository for development, and creating Portfiles.</para>
- <section id="portfile-development.portfile.introduction">
+ <section id="development.introduction">
<title>Portfile Introduction</title>
<para>A MacPorts Portfile is a TCL script that usually contains only the
simple keyword/value combinations and Tcl extensions as described in the
- <link linkend="portfile-reference">Portfile Reference</link> chapter,
- though it may also contain arbitrary TCL code. Every port has a
- corresponding Portfile, but Portfiles do not completely define a port's
- installation behavior since the MacPorts base has default port
- installation characteristics coded within it. Therefore Portfiles need
- only specify required options and, when required, non-default
- characteristics for a port.</para>
+ <link linkend="reference">Portfile Reference</link> chapter, though it may
+ also contain arbitrary TCL code. Every port has a corresponding Portfile,
+ but Portfiles do not completely define a port's installation behavior
+ since the MacPorts base has default port installation characteristics
+ coded within it. Therefore Portfiles need only specify required options
+ and, when required, non-default characteristics for a port.</para>
<para>A common way for Portfiles to augment or override MacPorts base
default installation phase characteristics is by using
@@ -66,16 +65,15 @@
destroot respectively. For applications that do not conform to this
standard behavior, any installation phase may be augmented using pre-
and/or post- phases, or even overridden or eliminated. See <link
- linkend="portfile-development.example.portfiles">Example Portfiles</link>
- below.</para>
+ linkend="development.examples">Example Portfiles</link> below.</para>
<note>
<para>For a detailed description of all port phases, see the <link
- linkend="portfile-reference">Portfile Reference</link> chapter.</para>
+ linkend="reference">Portfile Reference</link> chapter.</para>
</note>
</section>
- <section id="portfile-development.local.portfile.repositories">
+ <section id="development.local-repositories">
<title>Local Portfile Repositories</title>
<para>To create and test Portfiles that are not yet committed to
@@ -145,7 +143,7 @@
<screen>bestevergame games/bestevergame 1.1 The Best Ever Game</screen>
</section>
- <section id="portfile-development.creating.a.portfile">
+ <section id="development.creating-portfile">
<title>Creating a Portfile</title>
<para>Here we list the individual Portfile components for an application
@@ -201,9 +199,9 @@
responsibility for keeping the port up-to-date, and the maintainer
keyword lists maintainer email addresses(s). To hide these addresses
from spambots, see the more full explanation of the maintainer keyword
- in the <link linkend="portfile-reference.keywords.global">Global
- Keywords</link> section of the <link
- linkend="portfile-reference">Portfile Reference</link> chapter.</para>
+ in the <link linkend="reference.keywords.global">Global
+ Keywords</link> section of the <link linkend="reference">Portfile
+ Reference</link> chapter.</para>
<programlisting>maintainers julesverne at example.org</programlisting>
@@ -274,14 +272,14 @@
</orderedlist>
</section>
- <section id="portfile-development.example.portfiles">
+ <section id="development.examples">
<title>Example Portfiles</title>
<para>In this section we take a look at a complete simple Portfile, and
then pre- and post- phase definitions to augment and override the MacPorts
default phases.</para>
- <section id="portfile-development.example.portfiles.basic.portfile">
+ <section id="development.examples.basic">
<title>A Basic Portfile</title>
<programlisting># Id$
@@ -309,7 +307,7 @@
--mandir=${prefix}/share/man</programlisting>
</section>
- <section id="portfile-development.example.portfiles.pre.post">
+ <section id="development.examples.pre-post">
<title>Portfile Using Pre- / Post- Phases</title>
<para>To augment a port's installation phase, and not override it, you
@@ -324,7 +322,7 @@
}</programlisting>
</section>
- <section id="portfile-development.example.portfiles.override">
+ <section id="development.examples.override">
<title>Portfile that Overrides Default Phases</title>
<para>To override the automatic MacPorts installation phase processing,
@@ -336,7 +334,7 @@
}</programlisting>
</section>
- <section id="portfile-development.example.portfiles.startupitem">
+ <section id="development.examples.startupitem">
<title>Portfile Using a StartupItem</title>
<para>Startupitems may be placed in the global section of a
@@ -357,14 +355,14 @@
</section>
</section>
- <section id="portfile-development.port.variants">
+ <section id="development.variants">
<title>Port Variants</title>
<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 may provide a description.</para>
- <section id="portfile-development.port.variants.modify.options">
+ <section id="development.variants.options">
<title>Variants to Modify Options</title>
<para>The most common use for a variant is to add or remove
@@ -399,7 +397,7 @@
}</programlisting>
</section>
- <section id="portfile-development.port.variants.actions.phase">
+ <section id="development.variants.phase">
<title>Variant Actions in a Phase</title>
<para>If a variant requires options in addition to those provided by
@@ -421,7 +419,7 @@
}</programlisting>
</section>
- <section id="portfile-development.port.variants.default.variants">
+ <section id="development.variants.default">
<title>Default Variants</title>
<para>Variants are used to specify actions that lie outside the core
@@ -438,7 +436,7 @@
</section>
</section>
- <section id="portfile-development.patch.files">
+ <section id="development.patches">
<title>Patch Files</title>
<para>Patch files are files created with the Unix command
@@ -446,7 +444,7 @@
<command>patch</command> to modify text files to fix bugs or extend
functionality.</para>
- <section id="portfile-development.patch.files.portfile.patches">
+ <section id="development.patches.portfile">
<title>Creating Portfile Patches</title>
<para>If you wish to contribute modifications or fixes to a Portfile,
@@ -507,7 +505,7 @@
MacPorts Trac ticket for the port author to evaluate.</para>
</section>
- <section id="portfile-development.patch.files.source.patches">
+ <section id="development.patches.source">
<title>Creating Source Code Patches</title>
<para>Necessary or useful patches to application source code should be
@@ -575,7 +573,7 @@
</orderedlist>
</section>
- <section id="portfile-development.patch.files.manually.applying">
+ <section id="development.patches.applying">
<title>Manually Applying Patches</title>
<para>Though MacPorts applies patch files automatically, you may want to
@@ -603,25 +601,25 @@
</section>
</section>
- <section id="portfile-development.portfile.best.practices">
+ <section id="development.practices">
<title>Portfile Best Practices</title>
<para>This section contains practical guidelines for creating Portfiles
that install smoothly and provide consistency between ports.</para>
- <section>
+ <section id="development.practices.dont-overwrite">
<title>Don't Overwrite Config Files</title>
<para></para>
</section>
- <section>
+ <section id="development.practices.install-docs">
<title>Install Docs and Examples</title>
<para></para>
</section>
- <section>
+ <section id="development.practices.provide-messages">
<title>Provide User Messages</title>
<para></para>
Modified: trunk/doc/guide/new/xml/portfileref.xml
===================================================================
--- trunk/doc/guide/new/xml/portfileref.xml 2007-08-26 19:36:08 UTC (rev 28260)
+++ trunk/doc/guide/new/xml/portfileref.xml 2007-08-26 21:25:25 UTC (rev 28261)
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="portfile-reference">
+<chapter id="reference">
<title>Portfile Reference</title>
<para>This chapter serves as a reference for the major elements of a
<filename>Portfile</filename>: port phases, variants, StartupItems,
variables, keywords, and Tcl extensions.</para>
- <section id="portfile-reference.port.phases">
+ <section id="reference.phases">
<title>Port Phases</title>
<para>A MacPorts port has ten distinct phases. The MacPorts base is set to
@@ -16,13 +16,12 @@
<command>configure</command>, <command>make</command>, and <command>make
install</command> steps, but for applications that do not conform to this
behavior, installation phases may be declared in a Portfile to <link
- linkend="portfile-development.example.portfiles.pre.post">augment</link>
- or <link
- linkend="portfile-development.example.portfiles.override">override</link>
- the default behavior as described in the <link
- linkend="portfile-development">Portfile Development</link> chapter.</para>
+ linkend="development.examples.pre-post">augment</link> or <link
+ linkend="development.examples.override">override</link> the default
+ behavior as described in the <link linkend="development">Portfile
+ Development</link> chapter.</para>
- <section id="portfile-reference.port.phases.fetch">
+ <section id="reference.phases.fetch">
<title>Fetch</title>
<para>Overview: Fetch the <varname>${distfiles}</varname> from
@@ -30,7 +29,7 @@
<filename>${prefix}/var/macports/distfiles</filename>.</para>
</section>
- <section id="portfile-reference.port.phases.checksum">
+ <section id="reference.phases.checksum">
<title>Checksum</title>
<para>Overview: Compare <varname>${checksums}</varname> specified in a
@@ -38,14 +37,14 @@
${distfiles}.</para>
</section>
- <section id="portfile-reference.port.phases.extract">
+ <section id="reference.phases.extract">
<title>Extract</title>
<para>Overview: Unzip and untar the <varname>${distfiles}</varname> into
the path ${prefix}/var/macports/build/..../work</para>
</section>
- <section id="portfile-reference.port.phases.patch">
+ <section id="reference.phases.patch">
<title>Patch</title>
<para>Overview: Apply optional <ulink
@@ -60,21 +59,21 @@
diffs</ulink>.</para>
</section>
- <section id="portfile-reference.port.phases.configure">
+ <section id="reference.phases.configure">
<title>Configure</title>
<para>Overview: Execute the command "configure" in
<varname>${workpath}</varname>.</para>
</section>
- <section id="portfile-reference.port.phases.build">
+ <section id="reference.phases.build">
<title>Build</title>
<para>Overview: Execute the command "make" in
<varname>${workpath}</varname>.</para>
</section>
- <section id="portfile-reference.port.phases.destroot">
+ <section id="reference.phases.destroot">
<title>Destroot</title>
<para>Overview: Execute the command <command>make install
@@ -114,7 +113,7 @@
keyword.</para>
</section>
- <section id="portfile-reference.port.phases.archive">
+ <section id="reference.phases.archive">
<title>Archive</title>
<para>Overview: Use tar to create a tarball of a port's destrooted files
@@ -122,17 +121,17 @@
<filename>${prefix}/var/macports/packages/</filename>.</para>
</section>
- <section id="portfile-reference.port.phases.install">
+ <section id="reference.phases.install">
<title>Install</title>
<para>Overview: Copy a port's destrooted files into
<filename>${prefix}/var/macports/software</filename>. See <link
- linkend="macports-internals.port.images">Port Images</link> in the <link
- linkend="macports-internals">MacPorts Internals</link> chapter for
+ linkend="internals.images">Port Images</link> in the <link
+ linkend="internals">MacPorts Internals</link> chapter for
details.</para>
</section>
- <section id="portfile-reference.port.phases.activate">
+ <section id="reference.phases.activate">
<title>Activate</title>
<para>Overview: Set <ulink
@@ -142,7 +141,7 @@
</section>
</section>
- <section id="portfile-reference.dependencies">
+ <section id="reference.dependencies">
<title>Dependencies</title>
<para>Free and open source software is highly modular, and MacPorts ports
@@ -159,7 +158,7 @@
with a build dependency; likewise, upgrading a port will upgrade its
library and build dependencies also, but not its run dependencies.</para>
- <section id="portfile-reference.dependencies.dependslib">
+ <section id="reference.dependencies.dependslib">
<title>depends_lib</title>
<para>Library dependencies are needed both at build time (for headers
@@ -168,7 +167,7 @@
<programlisting>depends_lib port:rrdtool</programlisting>
</section>
- <section id="portfile-reference.dependencies.dependsbuild">
+ <section id="reference.dependencies.dependsbuild">
<title>depends_build</title>
<para>Build dependencies are needed when software is compiled, but not
@@ -177,7 +176,7 @@
<programlisting>depends_build port:gcc42</programlisting>
</section>
- <section id="portfile-reference.dependencies.dependsrun">
+ <section id="reference.dependencies.dependsrun">
<title>depends_run</title>
<para>Run dependencies are needed when the software is run, but not to
@@ -186,7 +185,7 @@
<programlisting>depends_run port:apache2</programlisting>
</section>
- <section id="portfile-reference.dependencies.nonport">
+ <section id="reference.dependencies.nonport">
<title>Non-Port Dependencies</title>
<para>Port dependencies should refer to other MacPorts ports whenever
@@ -216,7 +215,7 @@
</section>
</section>
- <section id="portfile-reference.startupitems">
+ <section id="reference.startupitems">
<title>StartupItems</title>
<para>StartupItems are keywords that create Mac OS X LaunchDaemon startup
@@ -329,13 +328,13 @@
</variablelist></para>
</section>
- <section id="portfile-reference.variables">
+ <section id="reference.variables">
<title>Variables</title>
<para>This section describes the MacPorts preset variables that may be
used within Portfiles.</para>
- <section id="portfile-reference.variables.general">
+ <section id="reference.variables.general">
<title>General</title>
<para>These are the variables available to any
@@ -462,7 +461,7 @@
</variablelist></para>
</section>
- <section id="portfile-reference.variables.portgroup">
+ <section id="reference.variables.portgroup">
<title>PortGroup Variables</title>
<para>In addition to the general <filename>Portfile</filename> type for
@@ -675,7 +674,7 @@
</section>
</section>
- <section id="portfile-reference.keywords">
+ <section id="reference.keywords">
<title>Keywords</title>
<para>MacPorts keywords are used to specify required or optional items
@@ -693,7 +692,7 @@
specify information to be used during a particular installation
phase.</para>
- <section id="portfile-reference.keywords.append.delete">
+ <section id="reference.keywords.append-delete">
<title>Using -append and -delete Keywords</title>
<para>It is often necessary to add to a list of keyword values
@@ -768,7 +767,7 @@
</itemizedlist>
</section>
- <section id="portfile-reference.keywords.global">
+ <section id="reference.keywords.global">
<title>Global Keywords</title>
<para>The list of global keywords.</para>
@@ -962,7 +961,7 @@
</variablelist>
</section>
- <section id="portfile-reference.keywords.fetch">
+ <section id="reference.keywords.fetch">
<title>Fetch</title>
<para>Thelist of keywords related to the fetch phase.</para>
@@ -1103,7 +1102,7 @@
</variablelist>
</section>
- <section id="portfile-reference.keywords.checksum">
+ <section id="reference.keywords.checksum">
<title>Checksum</title>
<para>The list of keywords related to the checksum phase.</para>
@@ -1127,7 +1126,7 @@
</variablelist>
</section>
- <section id="portfile-reference.keywords.extract">
+ <section id="reference.keywords.extract">
<title>Extract</title>
<para>The list of keywords related to the extract phase.</para>
@@ -1215,7 +1214,7 @@
</variablelist>
</section>
- <section id="portfile-reference.keywords.patch">
+ <section id="reference.keywords.patch">
<title>Patch</title>
<para>The list of keywords related to the patch phase.</para>
@@ -1239,7 +1238,7 @@
</variablelist>
</section>
- <section id="portfile-reference.keywords.configure">
+ <section id="reference.keywords.configure">
<title>Configure</title>
<para>The list of keywords related to the configure phase.</para>
@@ -1351,7 +1350,7 @@
</varlistentry>
</variablelist>
- <section>
+ <section id="reference.keywords.configure.automake-autoconf">
<title>Automake and Autoconf</title>
<para>The list of configure keywords available for ports that need
@@ -1447,7 +1446,7 @@
</section>
</section>
- <section id="portfile-reference.keywords.build">
+ <section id="reference.keywords.build">
<title>Build</title>
<para>The list of keywords related to the build phase.</para>
@@ -1516,7 +1515,7 @@
</variablelist>
</section>
- <section id="portfile-reference.keywords.destroot">
+ <section id="reference.keywords.destroot">
<title>Destroot</title>
<para>The list of keywords related to the destroot phase.</para>
@@ -1630,7 +1629,7 @@
</section>
</section>
- <section id="portfile-reference.tcl.extensions">
+ <section id="reference.tcl-extensions">
<title>Tcl Extensions</title>
<para>A MacPorts Portfile is a Tcl script, so it may contain any arbitrary
Modified: trunk/doc/guide/new/xml/project.xml
===================================================================
--- trunk/doc/guide/new/xml/project.xml 2007-08-26 19:36:08 UTC (rev 28260)
+++ trunk/doc/guide/new/xml/project.xml 2007-08-26 21:25:25 UTC (rev 28261)
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="macports-project">
+<chapter id="project">
<title>MacPorts Project</title>
<para>The MacPorts Project uses a system called <ulink
@@ -13,7 +13,7 @@
url="http://www.macports.org/wp-register.php">register</ulink> for a Trac
account to create tickets.</para>
- <section id="macports-project.creating.trac.tickets">
+ <section id="project.tickets">
<title>Creating Trac Tickets</title>
<para>Once you are logged into Trac, you may click <emphasis>View Tickets
@@ -31,7 +31,7 @@
</mediaobject>
</screenshot>
- <section id="macports-project.creating.trac.tickets.guidelines">
+ <section id="project.tickets.guidelines">
<title>Trac Ticket Guidelines</title>
<para>There are certain conventions used to ensure that Trac tickets
@@ -234,7 +234,7 @@
</section>
</section>
- <section id="macports-project.contributing">
+ <section id="project.contributing">
<title>Contributing to MacPorts</title>
<para>You may contribute new ports and port updates to current ports using
@@ -243,7 +243,7 @@
<!-- Should we have similar sections about committing to base sources and
documentation, or alternatively add this to the following? -->
- <section>
+ <section id="project.contributing.new">
<title>New Ports</title>
<para>Ports are contributed by following these steps. See Ticket
@@ -270,7 +270,7 @@
</orderedlist>
</section>
- <section>
+ <section id="project.contributing.updates">
<title>Port Updates</title>
<para>Portfile updates should always be contributed as
@@ -305,7 +305,7 @@
</section>
</section>
- <section id="macports-project.port.update.policies">
+ <section id="project.update-policies">
<title>Port Update Policies</title>
<para>Port maintainers normally are given commit privileges to the
@@ -315,7 +315,7 @@
port it is a good practice to inform a port's maintainer. See details
below.</para>
- <section id="macports-project.port.update.policies.nonmaintainer">
+ <section id="project.update-policies.nonmaintainer">
<title>Non-Maintainer Port Updates</title>
<para>If you have a port update or bugfix for a port you do not
@@ -374,7 +374,7 @@
</itemizedlist>
</section>
- <section id="macports-project.port.update.policies.abandonment">
+ <section id="project.update-policies.abandonment">
<title>Port Abandonment</title>
<para>A port may be considered abandoned if a bug has not been
@@ -403,7 +403,7 @@
</section>
</section>
- <section id="macports-project.macports.membership">
+ <section id="project.membership">
<title>MacPorts Membership</title>
<para>A requirement for a person to become a MacPorts committer is to
Modified: trunk/doc/guide/new/xml/using.xml
===================================================================
--- trunk/doc/guide/new/xml/using.xml 2007-08-26 19:36:08 UTC (rev 28260)
+++ trunk/doc/guide/new/xml/using.xml 2007-08-26 21:25:25 UTC (rev 28261)
@@ -1,14 +1,14 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd">
-<chapter id="using-macports">
+<chapter id="using">
<title>Using MacPorts</title>
<para>This chapter describes using the <command>port</command> command, port
variants, common tasks, port binaries, and setting up an rsync replication
server.</para>
- <section id="using-macports.port.command">
+ <section id="using.port">
<title>The port Command</title>
<para>The MacPorts <command>port</command> command is the main utility
@@ -16,7 +16,7 @@
<filename>Portfile</filename>s and the MacPorts infrastructure, and
install and manage ports.</para>
- <section id="using-macports.port.command.selfupdate">
+ <section id="using.port.selfupdate">
<title>selfupdate</title>
<para>The <option>selfupdate</option> option should be used regularly to
@@ -52,7 +52,7 @@
selfupdate done!</screen>
</section>
- <section id="using-macports.port.command.sync">
+ <section id="using.port.sync">
<title>sync</title>
<para>The sync option performs a subset of selfupdate actions. It
@@ -61,7 +61,7 @@
reason not to, you should use <option>selfupdate</option>.</para>
</section>
- <section id="using-macports.port.command.list">
+ <section id="using.port.list">
<title>list</title>
<para>The <option>list</option> option is used to get a list of all
@@ -70,7 +70,7 @@
<programlisting><prompt>%%</prompt> <userinput>port list</userinput></programlisting>
</section>
- <section id="using-macports.port.command.search">
+ <section id="using.port.search">
<title>search</title>
<para>The <option>search</option> option is very useful to find port
@@ -82,7 +82,7 @@
php5-rrdtool www/php5-rrdtool 1.0 PHP 5 glue for RRDtool</screen>
</section>
- <section id="using-macports.port.command.info">
+ <section id="using.port.info">
<title>info</title>
<para>The <option>info</option> option is used to get information about
@@ -99,7 +99,7 @@
Maintainers: nomaintainer at macports.org</screen>
</section>
- <section id="using-macports.port.command.deps">
+ <section id="using.port.deps">
<title>deps</title>
<para>The <option>deps</option> option shows you the dependencies of a
@@ -116,14 +116,13 @@
pcre</screen>
</section>
- <section id="using-macports.port.command.variants">
+ <section id="using.port.variants">
<title>variants</title>
<para>The <option>variants</option> option allows you to check what
variations of a port are available before you install it. Variants are a
way for port authors to provide options that may be invoked at install
- time. See <link
- linkend="using-macports.port.variants.invoking.variants">Invoking Port
+ time. See <link linkend="using.variants.invoking">Invoking Port
Variants</link> below to install ports that have variants.</para>
<programlisting><prompt>%%</prompt> <userinput>port variants nmap</userinput></programlisting>
@@ -135,12 +134,12 @@
no_pcre</screen>
</section>
- <section id="using-macports.port.command.install">
+ <section id="using.port.install">
<title>install</title>
<para>The option <option>install</option> is used to install a port. See
- <link linkend="using-macports.port.variants.invoking.variants">Invoking
- Port Variants</link> below to install ports that have variants.</para>
+ <link linkend="using.variants.invoking">Invoking Port Variants</link>
+ below to install ports that have variants.</para>
<programlisting><prompt>%%</prompt> <userinput>sudo port install nmap</userinput></programlisting>
@@ -152,7 +151,7 @@
</note>
</section>
- <section id="using-macports.port.command.clean">
+ <section id="using.port.clean">
<title>clean</title>
<para>The option <option>clean</option> deletes all intermediate files
@@ -169,7 +168,7 @@
</note>
</section>
- <section id="using-macports.port.command.uninstall">
+ <section id="using.port.uninstall">
<title>uninstall</title>
<para>The <option>uninstall</option> option will uninstall an installed
@@ -188,7 +187,7 @@
</note>
</section>
- <section id="using-macports.port.command.contents">
+ <section id="using.port.contents">
<title>contents</title>
<para>The <option>contents</option> option displays the files that have
@@ -204,7 +203,7 @@
/opt/local/share/doc/render/protocol</screen>
</section>
- <section id="using-macports.port.command.installed">
+ <section id="using.port.installed">
<title>installed</title>
<para>The <option>installed</option> option displays all installed
@@ -226,7 +225,7 @@
zlib @1.2.3_1 (active)</screen>
</section>
- <section id="using-macports.port.command.outdated">
+ <section id="using.port.outdated">
<title>outdated</title>
<para>The <option>outdated</option> option checks your installed ports
@@ -242,7 +241,7 @@
pkgconfig 0.21_0 < 0.22_0</screen>
</section>
- <section id="using-macports.port.command.upgrade">
+ <section id="using.port.upgrade">
<title>upgrade</title>
<para>The <option>upgrade</option> option upgrades installed ports and
@@ -264,20 +263,17 @@
<note>
<para>The <option>upgrade</option> option by default does not
uninstall an upgraded port —it deactivates it. See section <link
- linkend="macports-internals.port.images">Port Images</link>, and also
- <link
- linkend="portfile-reference.port.phases.destroot">Destroot</link> and
- <link
- linkend="portfile-reference.port.phases.activate">Activate</link>
- phases in <link linkend="portfile-reference.port.phases">Port
- Phases</link>. If you wish to uninstall the old version use the -u
- option.</para>
+ linkend="internals.images">Port Images</link>, and also <link
+ linkend="reference.phases.destroot">Destroot</link> and <link
+ linkend="reference.phases.activate">Activate</link> phases in <link
+ linkend="reference.phases">Port Phases</link>. If you wish to
+ uninstall the old version use the -u option.</para>
<programlisting><prompt>%%</prompt> <userinput>port -u upgrade vile</userinput></programlisting>
</note>
</section>
- <section id="using-macports.port.command.dependents">
+ <section id="using.port.dependents">
<title>dependents</title>
<para>The <option>dependents</option> option reports what ports depend
@@ -292,14 +288,14 @@
libdap depends on openssl</screen>
</section>
- <section id="using-macports.port.command.livecheck">
+ <section id="using.port.livecheck">
<title>livecheck</title>
<para></para>
</section>
</section>
- <section id="using-macports.port.variants">
+ <section id="using.variants">
<title>Port Variants</title>
<para>Variants are a way for port authors to provide options for a port
@@ -319,7 +315,7 @@
for all variants.</para>
</note>
- <section id="using-macports.port.variants.invoking.variants">
+ <section id="using.variants.invoking">
<title>Invoking Variants</title>
<para>A variant can only be invoked when a port is installed. After you
@@ -339,11 +335,11 @@
<screen>DEBUG: Executing variant ssl provides ssl</screen>
</section>
- <section id="using-macports.port.variants.negating.default.variants">
+ <section id="using.variants.negating">
<title>Negating Default Variants</title>
<para>For an explanation of default variants see <link
- linkend="portfile-development.port.variants">Port Variants</link>.
+ 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>
@@ -361,21 +357,21 @@
</section>
</section>
- <section id="using-macports.common.tasks">
+ <section id="using.common-tasks">
<title>Common Tasks</title>
<para>This section lists common operations you may want to perform when
managing a MacPorts installation.</para>
</section>
- <section id="using-macports.port.binaries">
+ <section id="using.binaries">
<title>Port Binaries</title>
<para>MacPorts can pre-compile ports into binaries so applications need
not be compiled when intalling on a target system. MacPorts may create two
types of binaries: archives and packages.</para>
- <section id="using-macports.port.binaries.binary.archives">
+ <section id="using.binaries.archives">
<title>Binary Archives</title>
<para>Binary archives can only be used on a target system running
@@ -419,7 +415,7 @@
cpio.</para>
</section>
- <section id="using-macports.port.binaries.binary.packages">
+ <section id="using.binaries.binary-packages">
<title>Binary Packages</title>
<para>Binary packages are standalone binary installers that are
@@ -445,7 +441,7 @@
<para>All packages are placed in a port's work directory.</para>
</section>
- <section id="using-macports.port.binaries.port.source.packages">
+ <section id="using.binaries.source-packages">
<title>Port Source Packages</title>
<para>Source packages are bundles consisting of a
@@ -457,7 +453,7 @@
</section>
</section>
- <section id="using-macports.rsync.replication.servers">
+ <section id="using.rsync-replication">
<title>Rsync Replication Servers</title>
<para>You may setup an rsync replication server on your local network to
@@ -467,7 +463,7 @@
and then serves as the rsync source when rsync replication clients on the
local network perform selfupdates.</para>
- <section id="using-macports.rsync.replication.servers.rsync.server.setup">
+ <section id="using.rsync-replication.server-setup">
<title>Rsync Server Setup</title>
<para>To setup a host as an rsync replication server, follow these
@@ -520,7 +516,7 @@
</orderedlist>
</section>
- <section id="using-macports.rsync.replication.servers.rsync.client.setup">
+ <section id="using.rsync-replication.client-setup">
<title>Rsync Client Setup</title>
<para>To setup a host as an rsync replication client, follow these
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20070826/b4e47f47/attachment.html
More information about the macports-changes
mailing list