[31880] trunk/doc-new/guide/xml
simon at macports.org
simon at macports.org
Mon Dec 10 13:44:14 PST 2007
Revision: 31880
http://trac.macosforge.org/projects/macports/changeset/31880
Author: simon at macports.org
Date: 2007-12-10 13:44:13 -0800 (Mon, 10 Dec 2007)
Log Message:
-----------
doc-new: Moved "Port Phases Introduction" to portfile-phases.7.xml so it's included in the man page and I think this is a better place. Also fixed some links.
Modified Paths:
--------------
trunk/doc-new/guide/xml/portfile-phase.7.xml
trunk/doc-new/guide/xml/portfiledev.xml
trunk/doc-new/guide/xml/portfileref.xml
trunk/doc-new/guide/xml/using.xml
Modified: trunk/doc-new/guide/xml/portfile-phase.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-phase.7.xml 2007-12-10 21:24:09 UTC (rev 31879)
+++ trunk/doc-new/guide/xml/portfile-phase.7.xml 2007-12-10 21:44:13 UTC (rev 31880)
@@ -5,6 +5,139 @@
<section id="reference.phases">
<title>Port Phases</title>
+ <section id="reference.phases.introduction">
+ <title>Introduction</title>
+
+ <para>A MacPorts port has ten distinct phases. The MacPorts base is set to
+ perform default steps for applications that use the standard
+ <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="development.examples.augment">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="reference.phases.introduction.fetch">
+ <title>Fetch</title>
+
+ <para>Overview: Fetch the <varname>${distfiles}</varname> from
+ <varname>${master_sites}</varname> and place it in
+ <filename>${prefix}/var/macports/distfiles</filename>.</para>
+ </section>
+
+ <section id="reference.phases.introduction.checksum">
+ <title>Checksum</title>
+
+ <para>Overview: Compare <varname>${checksums}</varname> specified in a
+ <filename>Portfile</filename> to the checksums of the fetched
+ ${distfiles}.</para>
+ </section>
+
+ <section id="reference.phases.introduction.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="reference.phases.introduction.patch">
+ <title>Patch</title>
+
+ <para>Overview: Apply optional <ulink
+ url="http://en.wikipedia.org/wiki/Patch_(Unix)">patch</ulink> files
+ specified in <varname>${patchfiles}</varname> to modify a port's source
+ code file(s).</para>
+
+ <para>Details: Patch files are made using the <ulink
+ url="http://en.wikipedia.org/wiki/Diff">diff</ulink> command, and
+ MacPorts patches should be created as <ulink
+ url="http://en.wikipedia.org/wiki/Diff#Unified_format">unified
+ diffs</ulink>.</para>
+ </section>
+
+ <section id="reference.phases.introduction.configure">
+ <title>Configure</title>
+
+ <para>Overview: Execute the command "configure" in
+ <varname>${workpath}</varname>.</para>
+ </section>
+
+ <section id="reference.phases.introduction.build">
+ <title>Build</title>
+
+ <para>Overview: Execute the command "make" in
+ <varname>${workpath}</varname>.</para>
+ </section>
+
+ <section id="reference.phases.introduction.destroot">
+ <title>Destroot</title>
+
+ <para>Overview: Execute the command <command>make install
+ DESTDIR=${destroot}</command> in <varname>${workpath}</varname>.</para>
+
+ <para>Details: 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. There are two main advantages to this method.</para>
+
+ <orderedlist>
+ <listitem>
+ <para>A port's files may be cleanly uninstalled because all files
+ and locations are tracked.</para>
+ </listitem>
+
+ <listitem>
+ <para>Since a port's files are not installed into MacPorts directory
+ structure until an activation phase, a port may be deactivated
+ through MacPorts to allow activation of a different version of the
+ same port, thus allowing two versions of a port to be present,
+ though not both active, on a given host.</para>
+ </listitem>
+ </orderedlist>
+
+ <note>
+ <para>The <varname>$(DESTDIR)</varname> variable must be supported in
+ an application's Makefile for the MacPorts destroot phase to work
+ properly. Urge developers to fully support
+ <varname>$(DESTDIR)</varname> in their Makefiles.</para>
+ </note>
+
+ <para>At the beginning of the destroot phase, all the directories in the
+ file <filename>${prefix}/etc/macports/prefix.mtree</filename> are
+ created. Any directories still empty upon completion of the destroot
+ phase are removed unless a directory is listed using a destroot.keepdirs
+ keyword.</para>
+ </section>
+
+ <section id="reference.phases.introduction.archive">
+ <title>Archive</title>
+
+ <para>Overview: Use tar to create a tarball of a port's destrooted files
+ and copy it to
+ <filename>${prefix}/var/macports/packages/</filename>.</para>
+ </section>
+
+ <section id="reference.phases.introduction.install">
+ <title>Install</title>
+
+ <para>Overview: Copy a port's destrooted files into
+ <filename>${prefix}/var/macports/software</filename>. See <link
+ linkend="internals.images">Port Images</link> in the <link
+ linkend="internals">MacPorts Internals</link> chapter for
+ details.</para>
+ </section>
+
+ <section id="reference.phases.introduction.activate">
+ <title>Activate</title>
+
+ <para>Overview: Set <ulink
+ url="http://en.wikipedia.org/wiki/Hard_link">hardlinks</ulink> pointing
+ to <filename>${prefix}/var/macports/software</filename> to point to
+ ${prefix}.</para>
+ </section>
+ </section>
+
<section id="reference.phases.installation">
<title>Installation Phase Keywords</title>
Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml 2007-12-10 21:24:09 UTC (rev 31879)
+++ trunk/doc-new/guide/xml/portfiledev.xml 2007-12-10 21:44:13 UTC (rev 31880)
@@ -74,7 +74,7 @@
<note>
<para>For a detailed description of all port phases, see the <link
- linkend="reference">Portfile Reference</link> chapter.</para>
+ linkend="reference.phases">Portfile Reference</link> chapter.</para>
</note>
</section>
Modified: trunk/doc-new/guide/xml/portfileref.xml
===================================================================
--- trunk/doc-new/guide/xml/portfileref.xml 2007-12-10 21:24:09 UTC (rev 31879)
+++ trunk/doc-new/guide/xml/portfileref.xml 2007-12-10 21:44:13 UTC (rev 31880)
@@ -29,137 +29,4 @@
<xi:include href="../../man/xml/portgroup.7.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
</section>
-
- <section id="reference.phases-old">
- <title>Port Phases</title>
-
- <para>A MacPorts port has ten distinct phases. The MacPorts base is set to
- perform default steps for applications that use the standard
- <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="development.examples.augment">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="reference.phases.fetch">
- <title>Fetch</title>
-
- <para>Overview: Fetch the <varname>${distfiles}</varname> from
- <varname>${master_sites}</varname> and place it in
- <filename>${prefix}/var/macports/distfiles</filename>.</para>
- </section>
-
- <section id="reference.phases.checksum">
- <title>Checksum</title>
-
- <para>Overview: Compare <varname>${checksums}</varname> specified in a
- <filename>Portfile</filename> to the checksums of the fetched
- ${distfiles}.</para>
- </section>
-
- <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="reference.phases.patch">
- <title>Patch</title>
-
- <para>Overview: Apply optional <ulink
- url="http://en.wikipedia.org/wiki/Patch_(Unix)">patch</ulink> files
- specified in <varname>${patchfiles}</varname> to modify a port's source
- code file(s).</para>
-
- <para>Details: Patch files are made using the <ulink
- url="http://en.wikipedia.org/wiki/Diff">diff</ulink> command, and
- MacPorts patches should be created as <ulink
- url="http://en.wikipedia.org/wiki/Diff#Unified_format">unified
- diffs</ulink>.</para>
- </section>
-
- <section id="reference.phases.configure">
- <title>Configure</title>
-
- <para>Overview: Execute the command "configure" in
- <varname>${workpath}</varname>.</para>
- </section>
-
- <section id="reference.phases.build">
- <title>Build</title>
-
- <para>Overview: Execute the command "make" in
- <varname>${workpath}</varname>.</para>
- </section>
-
- <section id="reference.phases.destroot">
- <title>Destroot</title>
-
- <para>Overview: Execute the command <command>make install
- DESTDIR=${destroot}</command> in <varname>${workpath}</varname>.</para>
-
- <para>Details: 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. There are two main advantages to this method.</para>
-
- <orderedlist>
- <listitem>
- <para>A port's files may be cleanly uninstalled because all files
- and locations are tracked.</para>
- </listitem>
-
- <listitem>
- <para>Since a port's files are not installed into MacPorts directory
- structure until an activation phase, a port may be deactivated
- through MacPorts to allow activation of a different version of the
- same port, thus allowing two versions of a port to be present,
- though not both active, on a given host.</para>
- </listitem>
- </orderedlist>
-
- <note>
- <para>The <varname>$(DESTDIR)</varname> variable must be supported in
- an application's Makefile for the MacPorts destroot phase to work
- properly. Urge developers to fully support
- <varname>$(DESTDIR)</varname> in their Makefiles.</para>
- </note>
-
- <para>At the beginning of the destroot phase, all the directories in the
- file <filename>${prefix}/etc/macports/prefix.mtree</filename> are
- created. Any directories still empty upon completion of the destroot
- phase are removed unless a directory is listed using a destroot.keepdirs
- keyword.</para>
- </section>
-
- <section id="reference.phases.archive">
- <title>Archive</title>
-
- <para>Overview: Use tar to create a tarball of a port's destrooted files
- and copy it to
- <filename>${prefix}/var/macports/packages/</filename>.</para>
- </section>
-
- <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="internals.images">Port Images</link> in the <link
- linkend="internals">MacPorts Internals</link> chapter for
- details.</para>
- </section>
-
- <section id="reference.phases.activate">
- <title>Activate</title>
-
- <para>Overview: Set <ulink
- url="http://en.wikipedia.org/wiki/Hard_link">hardlinks</ulink> pointing
- to <filename>${prefix}/var/macports/software</filename> to point to
- ${prefix}.</para>
- </section>
- </section>
</chapter>
Modified: trunk/doc-new/guide/xml/using.xml
===================================================================
--- trunk/doc-new/guide/xml/using.xml 2007-12-10 21:24:09 UTC (rev 31879)
+++ trunk/doc-new/guide/xml/using.xml 2007-12-10 21:44:13 UTC (rev 31880)
@@ -158,7 +158,7 @@
<para>You may break up a port's installation into smaller steps for
troubleshooting by passing <command>port</command> a prior
installation phase such as fetch, configure, build, or destroot. See
- section <link linkend="development.phases">Port Phases</link> for a
+ section <link linkend="reference.phases">Port Phases</link> for a
complete list of phases.</para>
</note>
</section>
@@ -278,10 +278,11 @@
<para>The <option>upgrade</option> option by default does not
uninstall an upgraded port —it deactivates it. See section <link
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 <option>-u</option> option.</para>
+ linkend="reference.phases.introduction.destroot">Destroot</link> and
+ <link linkend="reference.phases.introduction.activate">Activate</link>
+ phases in <link linkend="reference.phases">Port Phases</link>. If you
+ wish to uninstall the old version, use the <option>-u</option>
+ option.</para>
<programlisting><prompt>%%</prompt> <userinput>port -u upgrade vile</userinput></programlisting>
</note>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20071210/15b0bec2/attachment.html
More information about the macports-changes
mailing list