[31828] trunk/doc-new/guide/xml
simon at macports.org
simon at macports.org
Sun Dec 9 07:14:28 PST 2007
Revision: 31828
http://trac.macosforge.org/projects/macports/changeset/31828
Author: simon at macports.org
Date: 2007-12-09 07:14:26 -0800 (Sun, 09 Dec 2007)
Log Message:
-----------
doc-new: Integrated much data of the old portfile.7 man page. Also updated examples to follow our new whitespace conventions.
Modified Paths:
--------------
trunk/doc-new/guide/xml/portfile-global-keywords.7.xml
trunk/doc-new/guide/xml/portfile-global-variables.7.xml
trunk/doc-new/guide/xml/portfile-phase.7.xml
trunk/doc-new/guide/xml/portfile-startupitem.7.xml
trunk/doc-new/guide/xml/portfileref.xml
Modified: trunk/doc-new/guide/xml/portfile-global-keywords.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-global-keywords.7.xml 2007-12-09 14:33:35 UTC (rev 31827)
+++ trunk/doc-new/guide/xml/portfile-global-keywords.7.xml 2007-12-09 15:14:26 UTC (rev 31828)
@@ -39,7 +39,8 @@
<term>name</term>
<listitem>
- <para>The name of the Port; it should be lowercase.</para>
+ <para>The name of the Port; it should be lowercase to prevent
+ uninstallation problems due to a macports base bug.</para>
<programlisting>name foo</programlisting>
</listitem>
@@ -63,6 +64,9 @@
revisions. It should not be incremented for port revisions unless
it would benefit users to upgrade an installed port, and cleared
when the port is updated to a newer version.</para>
+ <para>It should be used if a bug in the Portfile was found and all
+ installations of this port have to be updated. If the change only
+ affects new installations, there is no need to increase it.</para>
<programlisting>revision 1</programlisting>
</listitem>
@@ -248,20 +252,27 @@
software when satisfying a dependency by a port is not practical or
desirable for a special reason. Dependencies of this type are called
non-port dependencies.</para>
+ <para>Non-port dependencies should only be used if the application or
+ library can be installed by multiple ports (for example stable and
+ -devel version) or if it can't be installed with Macports.</para>
<para>Port dependencies, the preferred type, are specified as shown in
these examples:</para>
- <programlisting>depends_lib port:rrdtool port:apache2
+ <programlisting>depends_lib port:rrdtool port:apache2
-depends_build port:apache2 port:php5</programlisting>
+depends_build port:libtool
+depends_run port:apache2 port:php5</programlisting>
+
<para>Non-port dependencies are specified as shown in these
examples:</para>
- <programlisting>depends_lib lib:libX11.6:xorg
+ <programlisting>depends_lib lib:libX11.6:xorg
-depends_build bin:rrdtool</programlisting>
+depends_build bin:glibtool:libtool
+
+depends_run path:${prefix}/lib/libltdl.a:libtool</programlisting>
</section>
</section>
@@ -297,8 +308,8 @@
<para>Example:</para>
<programlisting>variant gnome requires glib {
- configure.args-append --with-gnome
- depends_lib-append port:gnome-session
+ configure.args-append --with-gnome
+ depends_lib-append port:gnome-session
}</programlisting>
</listitem>
</itemizedlist>
@@ -313,6 +324,9 @@
lists which variants are enabled by default. This allows for
Portfile modularity and also allows users to suppress default
variants if they wish.</para>
+ <para>Due to a bug in the current Macports base default_variants
+ shouldn't be used at the moment as they cause problems while
+ upgrading ports.</para>
<itemizedlist>
<listitem>
@@ -322,7 +336,7 @@
<listitem>
<para>Example:</para>
- <programlisting>default_variants +ssl +tcpd
+ <programlisting>default_variants +ssl +tcpd
</programlisting>
</listitem>
@@ -356,7 +370,7 @@
<listitem>
<para>Example:</para>
- <programlisting>universal_variant no</programlisting>
+ <programlisting>universal_variant no</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -410,9 +424,8 @@
<para>Examples:</para>
<programlisting>livecheck.check regex
-livecheck.url http://dev.mysql.com/
-livecheck.regex "Generally Available (${major_version}\\.\[0-9.\]+)"
-</programlisting>
+livecheck.url ${homepage}
+livecheck.regex "Generally Available (\\d+(?:\\.\\d+)*)"</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -440,7 +453,7 @@
<listitem>
<para>Example:</para>
- <programlisting>livecheck.name hibernate</programlisting>
+ <programlisting>livecheck.name hibernate</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -536,7 +549,7 @@
<listitem>
<para>Example:</para>
- <programlisting>livecheck.url http://ftp.gnu.org/gnu/bison/</programlisting>
+ <programlisting>livecheck.url http://ftp.gnu.org/gnu/bison/</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -562,7 +575,7 @@
<listitem>
<para>Example:</para>
- <programlisting>livecheck.regex 4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
+ <programlisting>livecheck.regex 4th-([a-z0-9.]+)-unix.tar.gz</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -587,7 +600,7 @@
<listitem>
<para>Example:</para>
- <programlisting>livecheck md5 37e6a5b6516a680c7178b72021d3b706</programlisting>
+ <programlisting>livecheck.md5 37e6a5b6516a680c7178b72021d3b706</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -620,7 +633,7 @@
<listitem>
<para>Example:</para>
- <programlisting>distcheck.check none</programlisting>
+ <programlisting>distcheck.check none</programlisting>
</listitem>
</itemizedlist>
</listitem>
Modified: trunk/doc-new/guide/xml/portfile-global-variables.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-global-variables.7.xml 2007-12-09 14:33:35 UTC (rev 31827)
+++ trunk/doc-new/guide/xml/portfile-global-variables.7.xml 2007-12-09 15:14:26 UTC (rev 31828)
@@ -8,6 +8,8 @@
<para>Global variables are variables available to any Portfile. For a list
of additional variables available to ports that are assigned to a MacPorts
Portgroup, see portgroup(7).</para>
+ <para>All of these variables except <varname>prefix</varname> are
+ read-only!</para>
<variablelist>
<varlistentry>
@@ -19,7 +21,7 @@
overridden on a per port basis. For example, aqua applications are
installed in <filename>/Applications/MacPorts</filename>.</para>
- <para>Default: /opt/local</para>
+ <para>Default: <filename>/opt/local</filename></para>
</listitem>
</varlistentry>
@@ -44,6 +46,8 @@
<listitem>
<para>Full path to the Portfile location.</para>
+
+ <para>Value: <literal>work</literal></para>
</listitem>
</varlistentry>
@@ -53,14 +57,31 @@
<listitem>
<para>Path to port files relative to
<varname>${portpath}</varname>.</para>
+
+ <para>Value: <literal>files</literal></para>
</listitem>
</varlistentry>
<varlistentry>
+ <term>filespath</term>
+
+ <listitem>
+ <para>Path to port files relative to
+ <varname>${portpath}</varname>.</para>
+
+ <para>Value: <varname>${portpath}/${filesdir}</varname></para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>workpath</term>
<listitem>
<para>Full path to work directory.</para>
+
+ <!-- TODO: what is ${portbuildpath}? -->
+
+ <para>Value: <varname>${portbuildpath}/work</varname></para>
</listitem>
</varlistentry>
@@ -68,8 +89,9 @@
<term>worksrcpath</term>
<listitem>
- <para>Full path to extracted source code. Equivalent to
- <varname>${workpath}/${worksrcdir}</varname>.</para>
+ <para>Full path to extracted source code.</para>
+
+ <para>Value: <varname>${workpath}/${worksrcdir}</varname></para>
</listitem>
</varlistentry>
@@ -77,8 +99,9 @@
<term>destroot</term>
<listitem>
- <para>Full path into which software will be destrooted. Equivalent
- to <filename>${workpath}/destroot</filename>.</para>
+ <para>Full path into which software will be destrooted.</para>
+
+ <para>Value: <varname>${workpath}/destroot</varname></para>
</listitem>
</varlistentry>
@@ -87,6 +110,10 @@
<listitem>
<para>Location to store downloaded distfiles.</para>
+
+ <!-- TODO: which value have the variables? -->
+
+ <para>Value: <varname>${sysportpath}/distfiles/${dist_subdir}/</varname></para>
</listitem>
</varlistentry>
@@ -110,7 +137,7 @@
<term>os.platform</term>
<listitem>
- <para>Identifies platform type (ie, "darwin", "freebsd",
+ <para>Identifies platform type (ie "darwin", "freebsd",
etc).</para>
</listitem>
</varlistentry>
@@ -119,7 +146,7 @@
<term>os.arch</term>
<listitem>
- <para>Identifies hardware type (ie, "powerpc", "intel").</para>
+ <para>Identifies hardware type (ie "powerpc", "intel").</para>
</listitem>
</varlistentry>
@@ -133,6 +160,14 @@
</varlistentry>
<varlistentry>
+ <term>os.endian</term>
+
+ <listitem>
+ <para>Endianness of the processor (ie "bigEndian").</para>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>os.major</term>
<listitem>
@@ -140,5 +175,14 @@
for Darwin 8.0).</para>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>x11prefix</term>
+
+ <listitem>
+ <para>Absolute path to X11.</para>
+ </listitem>
+ </varlistentry>
+
</variablelist>
</section>
Modified: trunk/doc-new/guide/xml/portfile-phase.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-phase.7.xml 2007-12-09 14:33:35 UTC (rev 31827)
+++ trunk/doc-new/guide/xml/portfile-phase.7.xml 2007-12-09 15:14:26 UTC (rev 31828)
@@ -5,7 +5,7 @@
<section id="reference.phases">
<title>Port Phases</title>
- <section>
+ <section id="reference.phases.installation">
<title>Installation Phase Keywords</title>
<para>MacPorts keywords are used to specify required or optional items
@@ -122,7 +122,7 @@
</section>
- <section>
+ <section id="reference.phases.fetch">
<title>Fetch Phase Keywords</title>
<para>The list of keywords related to the fetch phase.</para>
@@ -145,8 +145,8 @@
<listitem>
<para>Examples:</para>
- <programlisting>master_sites http://www.somesite.org/files/ \
- http://www.somemirror.org/somesite_org/files/
+ <programlisting>master_sites http://www.somesite.org/files/ \
+ http://www.somemirror.org/somesite_org/files/
</programlisting>
@@ -154,7 +154,7 @@
MacPorts. Here the sourceforge and gnu mirrors are
used.</para>
- <programlisting>master_sites sourceforge gnu
+ <programlisting>master_sites sourceforge gnu
</programlisting>
@@ -163,8 +163,8 @@
mirror subdirectory does not match ${name}, then you may
specify it using after the mirror separated by a colon.</para>
- <programlisting>master_sites sourceforge:widget \
- gnu:widget
+ <programlisting>master_sites sourceforge:widget \
+ gnu:widget
</programlisting>
@@ -178,17 +178,40 @@
<varname>${name}</varname>; file tagtwo.tar.gz is fetched from
the gnu mirrors in subdirectory sources.</para>
- <programlisting>master_sites sourceforge::tagone \
- gnu:sources:tagtwo
+ <programlisting>master_sites sourceforge::tagone \
+ gnu:sources:tagtwo
-distfiles file_one.tar.gz:tagone \
- file_two.tar.gz:tagtwo</programlisting>
+distfiles file_one.tar.gz:tagone \
+ file_two.tar.gz:tagtwo</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
+ <term>master_sites.mirror_subdir</term>
+
+ <listitem>
+ <para>Subdirectory to append to all mirror sites for any list
+ specified in <varname>${master_sites}</varname>.</para>
+
+ <!-- TODO: add a better explanation -->
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${name}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>master_sites.mirror_subdir magic</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>patch_sites</term>
<listitem>
@@ -203,18 +226,41 @@
<listitem>
<para>Example:</para>
- <programlisting>patch_sites ftp://ftp.patchcityrepo.com/pub/magic/patches</programlisting>
+ <programlisting>patch_sites ftp://ftp.patchcityrepo.com/pub/magic/patches</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
<varlistentry>
+ <term>patch_sites.mirror_subdir</term>
+
+ <listitem>
+ <para>Subdirectory to append to all mirror sites for any list
+ specified in <varname>${patch_sites}</varname>.</para>
+
+ <!-- TODO: add a better explanation -->
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${name}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>patch_sites.mirror_subdir magic</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>distname</term>
<listitem>
<para>The name of the distribution filename, not including the
- extract suffix.</para>
+ extract suffix (see below).</para>
<itemizedlist>
<listitem>
@@ -224,7 +270,7 @@
<listitem>
<para>Example:</para>
- <programlisting>distname ${name}</programlisting>
+ <programlisting>distname ${name}</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -246,14 +292,34 @@
</listitem>
<listitem>
- <para>Example:</para>
+ <para>Examples:</para>
- <programlisting>distfiles ${name}-dev_src.tgz
+ <programlisting>distfiles ${name}-dev_src.tgz</programlisting>
+ <programlisting>distfiles file_one.tar.gz:tagone \
+ file_two.tar.gz:tagtwo</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
-distfiles file_one.tar.gz:tagone \
- file_two.tar.gz:tagtwo</programlisting>
+ <varlistentry>
+ <term>dist_subdir</term>
+
+ <listitem>
+ <para>Create a sub-directory in distpath to store all fetched
+ files.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${name}</varname></para>
</listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>dist_subdir vim${version}</programlisting>
+ </listitem>
</itemizedlist>
</listitem>
</varlistentry>
@@ -273,7 +339,7 @@
<listitem>
<para>Example:</para>
- <programlisting>extract.suffix .tgz</programlisting>
+ <programlisting>extract.suffix .tgz</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -283,7 +349,7 @@
<term>extract.mkdir</term>
<listitem>
- <para>This option is used to specify if the directory
+ <para>This keyword is used to specify if the directory
<filename>worksrcdir</filename> is part of the distfile or if it
should be created automatically and the distfiles should be
extracted there instead. This is useful for distfiles with a flat
@@ -298,7 +364,7 @@
<listitem>
<para>Example:</para>
- <programlisting>extract.mkdir yes</programlisting>
+ <programlisting>extract.mkdir yes</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -312,7 +378,7 @@
When invoked, it automatically sets:</para>
<literallayout>extract.suffix = .tar.bz
-extract.cmd = bzip
+extract.cmd = bzip
</literallayout>
@@ -324,7 +390,7 @@
<listitem>
<para>Example:</para>
- <programlisting>use_bzip2 yes</programlisting>
+ <programlisting>use_bzip2 yes</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -334,12 +400,12 @@
<term>use_zip</term>
<listitem>
- <para>This keyword is for downloads are zipped. When invoked, it
- automatically sets:</para>
+ <para>This keyword is for downloads which are zipped. When invoked,
+ it automatically sets:</para>
- <literallayout>extract.suffix = .zip
-extract.cmd = unzip
-extract.pre_args = -q
+ <literallayout>extract.suffix = .zip
+extract.cmd = unzip
+extract.pre_args = -q
extract.post_args = "-d ${portpath}/${workdir}"
</literallayout>
@@ -352,14 +418,126 @@
<listitem>
<para>Example:</para>
- <programlisting>use_zip yes</programlisting>
+ <programlisting>use_zip yes</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
+
+ <varlistentry>
+ <term>worksrcdir</term>
+
+ <listitem>
+ <para>Sets the path to source directory relative to workpath. It can
+ be used if the extracted source directory has a different name then
+ the distfile.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${distname}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>worksrcdir ${name}-src-${version}</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
</variablelist>
- <section>
+ <section id="reference.phases.fetch.advanced">
+ <title>Advanced Fetch Options</title>
+
+ <para>Some mirrors require special options for a resource to be properly
+ fetched.</para>
+
+ <variablelist>
+ <varlistentry>
+ <term>fetch.user</term>
+
+ <listitem>
+ <para>HTTP or FTP user to fetch the resource.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>TODO: add example</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>fetch.password</term>
+
+ <listitem>
+ <para>HTTP or FTP password to fetch the resource.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>TODO: add example</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>fetch.use_epsv</term>
+
+ <listitem>
+ <para>Whether to use EPSV command for FTP transfers.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>yes</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>fetch.use_epsv no</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>fetch.ignore_sslcert</term>
+
+ <listitem>
+ <para>Whether to ignore the host SSL certificate (for
+ HTTPS).</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>fetch.ignore_sslcert yes</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </section>
+
+ <section id="reference.phases.fetch.cvs">
<title>Fetch from CVS</title>
<para><ulink url="http://www.nongnu.org/cvs/">CVS</ulink> may be used
@@ -382,7 +560,7 @@
<listitem>
<para>Example:</para>
- <programlisting>cvs.root :pserver:anonymous at cvs.sv.gnu.org:/sources/emacs</programlisting>
+ <programlisting>cvs.root :pserver:anonymous at cvs.sv.gnu.org:/sources/emacs</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -403,7 +581,7 @@
<listitem>
<para>Example:</para>
- <programlisting>cvs.tag HEAD</programlisting>
+ <programlisting>cvs.tag HEAD</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -424,7 +602,7 @@
<listitem>
<para>Example:</para>
- <programlisting>cvs.date "12-April-2007"</programlisting>
+ <programlisting>cvs.date "12-April-2007"</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -444,7 +622,7 @@
<listitem>
<para>Example:</para>
- <programlisting>cvs.module Sources</programlisting>
+ <programlisting>cvs.module Sources</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -452,7 +630,7 @@
</variablelist>
</section>
- <section>
+ <section id="reference.phases.fetch.svn">
<title>Fetch from Subversion</title>
<para><ulink url="http://subversion.tigris.org/">Subversion</ulink>
@@ -476,9 +654,9 @@
<listitem>
<para>Examples:</para>
- <programlisting>svn.url http://www.domain.com/svn-repo/mydirectory
-svn.url svn://www.domain.com/svn-repo/mydirectory
-</programlisting>
+ <programlisting>svn.url http://www.domain.com/svn-repo/mydirectory</programlisting>
+
+ <programlisting>svn.url svn://www.domain.com/svn-repo/mydirectory</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -490,9 +668,7 @@
<listitem>
<para>Optional tag for fetching with Subversion, this specifies
the code revision to checkout; it corresponds to the -r option
- in the svn cli. You must use backslashes to escape characters
- that are meaningful to the Tcl interpreter, such as braces and
- double quotes.</para>
+ in the svn cli.</para>
<itemizedlist>
<listitem>
@@ -500,10 +676,9 @@
</listitem>
<listitem>
- <para>Examples:</para>
+ <para>Example:</para>
- <programlisting>svn.tag 37192
-svn.tag \{\"2006-02-17 15:30 +0230\"\}</programlisting>
+ <programlisting>svn.tag 37192</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -512,7 +687,7 @@
</section>
</section>
- <section>
+ <section id="reference.phases.checksum">
<title>Checksum Phase Keywords</title>
<para>The list of keywords related to the checksum phase.</para>
@@ -525,6 +700,8 @@
<para>Checksum(s) of the distribution files. For ports with
multiple distribution files, filenames must be included to
associate files with their checksums.</para>
+ <para>All checksum types (md5, sha1 and rdm160) should be used to
+ ensure the integrity of the distfiles.</para>
<itemizedlist>
<listitem>
@@ -534,16 +711,18 @@
<listitem>
<para>Examples:</para>
- <programlisting>checksums md5 dafa161bc9c61e57636a6085c87c1fe8 \
- sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
- rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23</programlisting>
+ <programlisting>checksums md5 dafa161bc9c61e57636a6085c87c1fe8 \
+ sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
+ rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23</programlisting>
- <programlisting>checksums ${distname}${extract.suffix} md5 dafa161bc9c61e57636a6085c87c1fe8 \
- sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
- rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23 \
- hobbit.tar.gz md5 3b8d02c6cf6239b9bdadbc6543c5a683 \
- sha1 27874638b23e66d39ed94fe716ca25c967f6e993 \
- rmd160 82b9991f3bf0ceedbf74c188c5fa44b98b5e40c9</programlisting>
+ <programlisting>checksums ${distname}${extract.suffix} \
+ md5 dafa161bc9c61e57636a6085c87c1fe8 \
+ sha1 5da610e1c8bc01b80abc21ab9e98e004363b429c \
+ rmd160 0c1147242adf476f5e93f4d59b553ee3ea378b23 \
+ hobbit.tar.gz \
+ md5 3b8d02c6cf6239b9bdadbc6543c5a683 \
+ sha1 27874638b23e66d39ed94fe716ca25c967f6e993 \
+ rmd160 82b9991f3bf0ceedbf74c188c5fa44b98b5e40c9</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -551,7 +730,7 @@
</variablelist>
</section>
- <section>
+ <section id="reference.phases.extract">
<title>Extract Phase Keywords</title>
<para>The list of keywords related to the extract phase.</para>
@@ -566,31 +745,23 @@
<listitem>
<para>List of files to extract into
- <varname>${worksrcpath}</varname>; the default is
- <varname>${distfiles}</varname>. Only use if default extract
+ <varname>${worksrcpath}</varname>. Only use if default extract
behavior is not correct for your port.</para>
<itemizedlist>
<listitem>
- <para>Default: none</para>
+ <para>Default: <varname>${distfiles}</varname></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>extract.only foo.tar.gz
-
-</programlisting>
+ <programlisting>extract.only foo.tar.gz</programlisting>
+ <programlisting>extract.only-append bar.tar.gz
+extract.only-delete foo.tar.gz</programlisting>
</listitem>
</itemizedlist>
</listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>extract.only-append bar.tar.gz
-extract.only-delete foo.tar.gz</programlisting>
- </listitem>
</varlistentry>
<varlistentry>
@@ -601,13 +772,13 @@
<itemizedlist>
<listitem>
- <para>Default: gzip</para>
+ <para>Default: <command>gzip</command></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>extract.cmd gunzip</programlisting>
+ <programlisting>extract.cmd gunzip</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -626,13 +797,13 @@
<itemizedlist>
<listitem>
- <para>Default: ${distpath}/${distfile}</para>
+ <para>Default: <varname>${distpath}/${distfile}</varname></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>extract.args ${distpath}/${distfile}
+ <programlisting>extract.args ${distpath}/${distfile}
</programlisting>
</listitem>
@@ -644,18 +815,20 @@
<itemizedlist>
<listitem>
- <para>extract.pre_args default: "-dc"</para>
+ <para><literal>extract.pre_args</literal>, defaults to:
+ <literal>-dc</literal></para>
</listitem>
<listitem>
- <para>extract.post_args default: " | tar -xf"</para>
+ <para><literal>extract.post_args</literal>, defaults to:
+ <literal>"| tar -xf"</literal></para>
</listitem>
<listitem>
<para>Examples:</para>
- <programlisting>extract.pre_args xf
-extract.post_args "| gnutar –x"</programlisting>
+ <programlisting>extract.pre_args xf
+extract.post_args "| gnutar –x"</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -663,7 +836,7 @@
</variablelist>
</section>
- <section>
+ <section id="reference.phases.patch">
<title>Patch Phase Keywords</title>
<para>The list of keywords related to the patch phase.</para>
@@ -683,7 +856,7 @@
<listitem>
<para>Example:</para>
- <programlisting>patch.dir ${worksrcpath}/util</programlisting>
+ <programlisting>patch.dir ${worksrcpath}/util</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -703,7 +876,7 @@
<listitem>
<para>Example:</para>
- <programlisting>patch.cmd cat</programlisting>
+ <programlisting>patch.cmd cat</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -729,21 +902,13 @@
<listitem>
<para>Example:</para>
- <programlisting>patchfiles patch-Makefile.in \
- patch-source.c
-
-</programlisting>
+ <programlisting>patchfiles patch-Makefile.in \
+ patch-source.c</programlisting>
+ <programlisting>patchfiles-append patch-configure
+patchfiles-delete patch-src-Makefile.in</programlisting>
</listitem>
</itemizedlist>
</listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>patchfiles-append patch-configure
-patchfiles-delete patch-src-Makefile.in
-</programlisting>
- </listitem>
</varlistentry>
<varlistentry>
@@ -765,7 +930,7 @@
<listitem>
<para>Example:</para>
- <programlisting>patch.args ???
+ <programlisting>patch.args ???
</programlisting>
</listitem>
@@ -777,18 +942,20 @@
<itemizedlist>
<listitem>
- <para>patch.pre_args default: -p0</para>
+ <para><literal>patch.pre_args</literal>, defaults to:
+ <literal>-p0</literal></para>
</listitem>
<listitem>
- <para>patch.post_args default: none</para>
+ <para><literal>patch.post_args</literal>, defaults to:
+ none</para>
</listitem>
<listitem>
<para>Examples:</para>
- <programlisting>patch.pre_args -p1
-patch.post_args ???</programlisting>
+ <programlisting>patch.pre_args -p1
+patch.post_args ???</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -796,7 +963,7 @@
</variablelist>
</section>
- <section>
+ <section id="reference.phases.configure">
<title>Configure Phase Keywords</title>
<para>The list of keywords related to the configure phase.</para>
@@ -810,6 +977,26 @@
<variablelist>
<varlistentry>
+ <term>use_configure</term>
+
+ <listitem>
+ <para>Sets if the configure phase should be run.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>yes</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>use_configure no</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>configure.env</term>
<term>configure.env-append</term>
@@ -821,7 +1008,7 @@
and delete items from a previous Portfile configure.env keyword,
or a default set by MacPorts base. If available, it is encouraged
to use the predefined options (like configure.cflags) instead of
- modifying configure.env directly</para>
+ modifying configure.env directly.</para>
<itemizedlist>
<listitem>
@@ -832,18 +1019,12 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.env QTDIR=${prefix}/lib/qt3
-</programlisting>
+ <programlisting>configure.env QTDIR=${prefix}/lib/qt3</programlisting>
+ <programlisting>configure.env-append ABI=32
+configure.env-delete TCLROOT=${prefix}</programlisting>
</listitem>
</itemizedlist>
</listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>configure.env-append ABI=32
-configure.env-delete TCLROOT=${prefix}</programlisting>
- </listitem>
</varlistentry>
<varlistentry>
@@ -866,19 +1047,12 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.cflags -Os -flat_namespace
-
-</programlisting>
+ <programlisting>configure.cflags -Os -flat_namespace</programlisting>
+ <programlisting>configure.cflags-append "-undefined suppress"
+configure.cflags-delete -O2</programlisting>
</listitem>
</itemizedlist>
</listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>configure.cflags-append "-undefined suppress"
-configure.cflags-delete -O2</programlisting>
- </listitem>
</varlistentry>
<varlistentry>
@@ -901,19 +1075,12 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.ldflags -L${worksrcpath}/zlib -lz
-
-</programlisting>
+ <programlisting>configure.ldflags "-L${worksrcpath}/zlib -lz"</programlisting>
+ <programlisting>configure.ldflags-append "-L/usr/X11R6/lib -L${worksrcpath}/lib"
+configure.ldflags-delete -L${prefix}/lib/db44</programlisting>
</listitem>
</itemizedlist>
</listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>configure.ldflags-append "-L/usr/X11R6/lib -L${worksrcpath}/lib"
-configure.ldflags-delete -L${prefix}/lib/db44</programlisting>
- </listitem>
</varlistentry>
<varlistentry>
@@ -936,21 +1103,112 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.cppflags -I${worksrcpath}/include
+ <programlisting>configure.cppflags -I${worksrcpath}/include</programlisting>
+ <programlisting>configure.cppflags-append "-I/usr/X11R6/lib -I${worksrcpath}/lib -DHAVE_RRD_12X"
+configure.cppflags-delete -I${prefix}/lib/db44</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
-</programlisting>
+ <varlistentry>
+ <term>configure.cxxflags</term>
+
+ <term>configure.cxxflags-append</term>
+
+ <term>configure.cxxflags-delete</term>
+
+ <listitem>
+ <para>Set CXXFLAGS to be passed to the C++ processor; list modifiers
+ add or delete items from a previous Portfile configure.cxxflags
+ keyword or the default set by MacPorts base.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-O2</literal></para>
</listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>TODO: add example</programlisting>
+ </listitem>
</itemizedlist>
</listitem>
+ </varlistentry>
+ <varlistentry>
+ <term>configure.objcflags</term>
+
+ <term>configure.objcflags-append</term>
+
+ <term>configure.objcflags-delete</term>
+
<listitem>
- <para>List modifier examples:</para>
+ <para>TODO: add description</para>
- <programlisting>configure.cppflags-append "-I/usr/X11R6/lib -I${worksrcpath}/lib -DHAVE_RRD_12X"
-configure.cppflags-delete -I${prefix}/lib/db44</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>-O2</literal></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>TODO: add example</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term>configure.classpath</term>
+
+ <term>configure.classpath-append</term>
+
+ <term>configure.classpath-delete</term>
+
+ <listitem>
+ <para>TODO: add description</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>TODO: add example</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
+ <term>configure.macosx_deployment_target</term>
+
+ <term>configure.macosx_deployment_target-append</term>
+
+ <term>configure.macosx_deployment_target-delete</term>
+
+ <listitem>
+ <para>TODO: add description</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>TODO: add example</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
<!-- fortran compiler options -->
<varlistentry>
@@ -974,9 +1232,7 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.fflags -Os
-
-</programlisting>
+ <programlisting>configure.fflags -Os</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1003,9 +1259,7 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.fcflags -Os
-
-</programlisting>
+ <programlisting>configure.fcflags -Os</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1032,9 +1286,7 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.f90flags -Os
-
-</programlisting>
+ <programlisting>configure.f90flags -Os</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1048,17 +1300,17 @@
<term>configure.cc</term>
<listitem>
- <para>Set CC compiler flags for selecting a C compiler;</para>
+ <para>Set CC compiler flags for selecting a C compiler.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.cc ${prefix}/bin/gcc-mp-4.2</programlisting>
+ <programlisting>configure.cc ${prefix}/bin/gcc-mp-4.2</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1069,17 +1321,17 @@
<listitem>
<para>Set CPP compiler flags for selecting a C
- preprocessor;</para>
+ preprocessor.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.cpp /usr/bin/cpp-3.3</programlisting>
+ <programlisting>configure.cpp /usr/bin/cpp-3.3</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1089,17 +1341,17 @@
<term>configure.cxx</term>
<listitem>
- <para>Set CXX compiler flags for selecting a C++ compiler;</para>
+ <para>Set CXX compiler flags for selecting a C++ compiler.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.cpp /usr/bin/g++-4.0</programlisting>
+ <programlisting>configure.cxx /usr/bin/g++-4.0</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1110,17 +1362,17 @@
<listitem>
<para>Set OBJC compiler flags for selecting an Objective-C
- compiler;</para>
+ compiler.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.objc /usr/bin/gcc-4.0</programlisting>
+ <programlisting>configure.objc /usr/bin/gcc-4.0</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1131,17 +1383,17 @@
<listitem>
<para>Set FC compiler flags for selecting a Fortran
- compiler;</para>
+ compiler.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.fc ${prefix}/bin/gfortran-mp-4.2</programlisting>
+ <programlisting>configure.fc ${prefix}/bin/gfortran-mp-4.2</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1152,17 +1404,17 @@
<listitem>
<para>Set F77 compiler flags for selecting a Fortran 77
- compiler;</para>
+ compiler.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.f77 ${prefix}/bin/gfortran-mp-4.2</programlisting>
+ <programlisting>configure.f77 ${prefix}/bin/gfortran-mp-4.2</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1173,17 +1425,17 @@
<listitem>
<para>Set F90 compiler flags for selecting a Fortran 90
- compiler;</para>
+ compiler.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.f90 ${prefix}/bin/gfortran-mp-4.2</programlisting>
+ <programlisting>configure.f90 ${prefix}/bin/gfortran-mp-4.2</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1194,17 +1446,17 @@
<listitem>
<para>Set JAVAC compiler flags for selecting a Java
- compiler;</para>
+ compiler.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.javac ${prefix}/bin/jikes</programlisting>
+ <programlisting>configure.javac ${prefix}/bin/jikes</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1223,13 +1475,16 @@
<itemizedlist>
<listitem>
- <para>Default: <literal>gcc-3.3</literal>Mac OS X 10.3</para>
-
- <para>Default: <literal>gcc-4.0</literal>Mac OS X 10.4,
+ <para>Default: <literal>gcc-3.3</literal> on Mac OS X
+ 10.3</para>
+ </listitem>
+ <listitem>
+ <para>Default: <literal>gcc-4.0</literal> on Mac OS X 10.4 and
10.5</para>
</listitem>
<listitem>
+ <!-- TODO: should this be Options or renamed? -->
<para>Options:</para>
<programlisting>gcc-3.3 gcc-4.0 apple-gcc-3.3 apple-gcc-4.0 macports-gcc-3.3 macports-gcc-3.4 macports-gcc-4.0 macports-gcc-4.1 macports-gcc-4.2 macports-gcc-4.3</programlisting>
@@ -1238,7 +1493,7 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.compiler macports-gcc-4.2</programlisting>
+ <programlisting>configure.compiler macports-gcc-4.2</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1252,17 +1507,17 @@
<term>configure.perl</term>
<listitem>
- <para>Set PERL flag for selecting a Perl interpreter;</para>
+ <para>Set PERL flag for selecting a Perl interpreter.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.perl ${prefix}/bin/perl5.8</programlisting>
+ <programlisting>configure.perl ${prefix}/bin/perl5.8</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1272,11 +1527,11 @@
<term>configure.python</term>
<listitem>
- <para>Set PYTHON flag for selecting a Python interpreter;</para>
+ <para>Set PYTHON flag for selecting a Python interpreter.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
@@ -1292,17 +1547,17 @@
<term>configure.ruby</term>
<listitem>
- <para>Set RUBY flag for selecting a Ruby interpreter;</para>
+ <para>Set RUBY flag for selecting a Ruby interpreter.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.ruby ${prefix}/bin/ruby</programlisting>
+ <programlisting>configure.ruby ${prefix}/bin/ruby</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1317,7 +1572,7 @@
<listitem>
<para>Set INSTALL flag for selecting an install tool; used for
- copying files and creating directories</para>
+ copying files and creating directories.</para>
<itemizedlist>
<listitem>
@@ -1327,7 +1582,7 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.install ${prefix}/bin/ginstall</programlisting>
+ <programlisting>configure.install ${prefix}/bin/ginstall</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1337,17 +1592,17 @@
<term>configure.awk</term>
<listitem>
- <para>Set AWK flag for selecting an awk executable</para>
+ <para>Set AWK flag for selecting an awk executable.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.awk ${prefix}/bin/gawk</programlisting>
+ <programlisting>configure.awk ${prefix}/bin/gawk</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1358,17 +1613,17 @@
<listitem>
<para>Set BISON flag for selecting a bison executable, a parser
- generator</para>
+ generator.</para>
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.bison /usr/bin/bison</programlisting>
+ <programlisting>configure.bison /usr/bin/bison</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1383,7 +1638,7 @@
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
@@ -1404,13 +1659,13 @@
<itemizedlist>
<listitem>
- <para>Default: <literal></literal></para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>configure.pkg_config_path ${prefix}/lib/pkgconfig:${x11prefix}/lib/pkgconfig</programlisting>
+ <programlisting>configure.pkg_config_path ${prefix}/lib/pkgconfig:${x11prefix}/lib/pkgconfig</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1437,7 +1692,7 @@
<listitem>
<para>Example:</para>
- <programlisting>configure.args --bindir=${prefix}/bin
+ <programlisting>configure.args --bindir=${prefix}/bin
</programlisting>
</listitem>
@@ -1449,25 +1704,27 @@
<itemizedlist>
<listitem>
- <para>configure.pre_args default: --prefix=${prefix}</para>
+ <para><literal>configure.pre_args</literal>, defaults to:
+ <literal>--prefix=${prefix}</literal></para>
</listitem>
<listitem>
- <para>configure.post_args default: none</para>
+ <para><literal>configure.post_args</literal>, defaults to:
+ none</para>
</listitem>
<listitem>
<para>Examples:</para>
- <programlisting>configure.pre_args --prefix=${prefix}/share/bro
-configure.post_args OPT="-D__DARWIN_UNIX03"</programlisting>
+ <programlisting>configure.pre_args --prefix=${prefix}/share/bro
+configure.post_args OPT="-D__DARWIN_UNIX03"</programlisting>
</listitem>
</itemizedlist>
</listitem>
</varlistentry>
</variablelist>
- <section>
+ <section id="reference.phases.configure.universal">
<title>Configure Universal</title>
<para>Universal keywords are used to make a port compile on the OS X
@@ -1490,13 +1747,14 @@
<itemizedlist>
<listitem>
- <para>Default: --disable-dependency-tracking</para>
+ <para>Default:
+ <literal>--disable-dependency-tracking</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting></programlisting>
+ <programlisting>TODO: add example</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1511,14 +1769,15 @@
<itemizedlist>
<listitem>
- <para>Default: -sysroot /Developer/SDKs/MacOSX10.4u.sdk
- -arch i386 -arch ppc</para>
+ <para>Default: <literal>-sysroot
+ /Developer/SDKs/MacOSX10.4u.sdk -arch i386 -arch
+ ppc</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting></programlisting>
+ <programlisting>TODO: add example</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1533,13 +1792,13 @@
<itemizedlist>
<listitem>
- <para>Default: ???</para>
+ <para>Default: <literal>???</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting></programlisting>
+ <programlisting>TODO: add example</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1554,14 +1813,15 @@
<itemizedlist>
<listitem>
- <para>Default: -isysroot /Developer/SDKs/MacOSX10.4u.sdk
- -arch i386 -arch ppc</para>
+ <para>Default: <literal>-isysroot
+ /Developer/SDKs/MacOSX10.4u.sdk -arch i386 -arch
+ ppc</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting></programlisting>
+ <programlisting>TODO: add example</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1576,13 +1836,13 @@
<itemizedlist>
<listitem>
- <para>Default: -arch i386 -arch ppc</para>
+ <para>Default: <literal>-arch i386 -arch ppc</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting></programlisting>
+ <programlisting>TODO: add example</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1590,7 +1850,7 @@
</variablelist>
</section>
- <section>
+ <section id="reference.phases.configure.automake-autoconf">
<title>Automake and Autoconf</title>
<para>The list of configure keywords available for ports that need
@@ -1601,10 +1861,19 @@
<term>use_automake</term>
<listitem>
- <para>Whether or not to use automake; the default is
- "no".</para>
+ <para>Whether or not to use automake.</para>
- <programlisting>use_automake yes</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>use_automake yes</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1614,7 +1883,17 @@
<listitem>
<para>Environment variables to pass to automake.</para>
- <programlisting>automake.env CFLAGS=-I${prefix}/include</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>automake.env CFLAGS=-I${prefix}/include</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1624,7 +1903,17 @@
<listitem>
<para>Arguments to pass to automake.</para>
- <programlisting>automake.args --foreign</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>automake.args --foreign</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1633,10 +1922,19 @@
<listitem>
<para>Directory in which to run
- <varname>${automake.cmd}</varname>; the default is
- <varname>${worksrcpath}</varname>.</para>
+ <varname>${automake.cmd}</varname>.</para>
- <programlisting>automake.dir ./src</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${worksrcpath}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>automake.dir ./src</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1644,10 +1942,19 @@
<term>use_autoconf</term>
<listitem>
- <para>Whether or not to use autoconf; the default is
- "no".</para>
+ <para>Whether or not to use autoconf.</para>
- <programlisting>use_autoconf yes</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>use_autoconf yes</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1657,7 +1964,17 @@
<listitem>
<para>Environmental variables to pass to autoconf.</para>
- <programlisting>autoconf.env CFLAGS=-I${prefix}/include/gtk12</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>autoconf.env CFLAGS=-I${prefix}/include/gtk12</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1667,7 +1984,17 @@
<listitem>
<para>Arguments to pass to autoconf.</para>
- <programlisting>autoconf.args -l src/aclocaldir</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>autoconf.args "-l src/aclocaldir"</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1676,17 +2003,26 @@
<listitem>
<para>Directory in which to run
- <varname>${autoconf.cmd}</varname>; the default is
- <varname>${worksrcpath}</varname>.</para>
+ <varname>${autoconf.cmd}</varname>.</para>
- <programlisting>autoconf.dir src</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${worksrcpath}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>autoconf.dir src</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
</variablelist>
</section>
</section>
- <section>
+ <section id="reference.phases.build">
<title>Build Phase Keywords</title>
<para>The list of keywords related to the build phase.</para>
@@ -1699,7 +2035,17 @@
<para>Make command to run in <varname>${worksrcdir}</varname>; the
default is "make".</para>
- <programlisting>build.cmd pbxbuild</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <command>make</command></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>build.cmd pbxbuild</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1710,7 +2056,19 @@
<para>Defines which "make" is required: "gnu" or "bsd". Sets
build.cmd to either "gnumake" or "bsdmake" accordingly.</para>
- <programlisting>build.type gnu</programlisting>
+ <!-- TODO: how to display "gnu" or "bsd". -->
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>gnu</literal></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>build.type bsd</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1722,8 +2080,9 @@
<term>build.post_args</term>
<listitem>
- <para>Main arguments to build.cmd; optional argument modifiers
- pass arguments before and after the main arguments.</para>
+ <para>Main arguments to <varname>${build.cmd}</varname>; optional
+ argument modifiers pass arguments before and after the main
+ arguments.</para>
<itemizedlist>
<listitem>
@@ -1733,7 +2092,7 @@
<listitem>
<para>Example:</para>
- <programlisting>build.args -DNOWARN
+ <programlisting>build.args -DNOWARN
</programlisting>
</listitem>
@@ -1745,19 +2104,20 @@
<itemizedlist>
<listitem>
- <para>build.pre_args default:
+ <para><literal>build.pre_args</literal>, defaults to:
<varname>${build.target.current}</varname></para>
</listitem>
<listitem>
- <para>build.post_args default: none</para>
+ <para><literal>build.post_args</literal>, defaults to:
+ none</para>
</listitem>
<listitem>
<para>Examples:</para>
- <programlisting>build.pre_args -project AudioSlicer.xcode
-build.post_args CFLAGS_SYS="-DUSE_FREETYPE -DPREFER_FREETYPE"</programlisting>
+ <programlisting>build.pre_args -project AudioSlicer.xcode
+build.post_args CFLAGS_SYS="-DUSE_FREETYPE -DPREFER_FREETYPE"</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1771,31 +2131,24 @@
<term>build.target-delete</term>
<listitem>
- <para>Build target to pass to ${build.cmd}; list modifiers add or
- delete items from a previous Portfile build.target keyword or the
- default set by MacPorts base.</para>
+ <para>Build target to pass to <varname>${build.cmd}</varname>; list
+ modifiers add or delete items from a previous Portfile build.target
+ keyword or the default set by MacPorts base.</para>
<itemizedlist>
<listitem>
- <para>Default: all</para>
+ <para>Default: <literal>all</literal></para>
</listitem>
<listitem>
<para>Example:</para>
- <programlisting>build.target all-src
-
-</programlisting>
+ <programlisting>build.target all-src</programlisting>
+ <programlisting>build.target-append doc extra
+build.target-delete compat</programlisting>
</listitem>
</itemizedlist>
</listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>build.target-append doc extra
-build.target-delete compat</programlisting>
- </listitem>
</varlistentry>
<varlistentry>
@@ -1820,7 +2173,7 @@
<listitem>
<para>Example:</para>
- <programlisting>use_parallel_build yes</programlisting>
+ <programlisting>use_parallel_build yes</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1828,7 +2181,7 @@
</variablelist>
</section>
- <section>
+ <section id="reference.phases.destroot">
<title>Destroot Phase Keywords</title>
<para>The list of keywords related to the destroot phase.</para>
@@ -1839,10 +2192,19 @@
<listitem>
<para>Install command to run relative to
- <varname>${worksrcdir}</varname>; default is
- <varname>${build.cmd}</varname>.</para>
+ <varname>${worksrcdir}</varname>.</para>
- <programlisting>destroot.cmd pbxbuild</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${build.cmd}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>destroot.cmd pbxbuild</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1850,11 +2212,23 @@
<term>destroot.type</term>
<listitem>
- <para>Defines which "make" is required: either "gnu" or "bsd".
- Sets install.cmd to either "gnumake" or "bsdmake"
+ <para>Defines which "make" is required: either "gnu" or "bsd". Sets
+ <varname>${destroot.cmd}</varname> to either "gnumake" or "bsdmake"
accordingly.</para>
- <programlisting>destroot.type gnu</programlisting>
+ <!-- TODO: Options? -->
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <varname>${build.type}</varname></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>destroot.type bsd</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1866,8 +2240,8 @@
<term>destroot.post_args</term>
<listitem>
- <para>Main arguments to ${destroot.cmd}; optional argument
- modifiers pass arguments before and after the main
+ <para>Main arguments to <varname>${destroot.cmd}</varname>; optional
+ argument modifiers pass arguments before and after the main
arguments.</para>
<itemizedlist>
@@ -1878,7 +2252,7 @@
<listitem>
<para>Example:</para>
- <programlisting>destroot.args BINDIR=${prefix}/bin
+ <programlisting>destroot.args BINDIR=${prefix}/bin
</programlisting>
</listitem>
@@ -1890,19 +2264,20 @@
<itemizedlist>
<listitem>
- <para>destroot.pre_args default:
+ <para><literal>destroot.pre_args</literal>, defaults to:
<varname>${destroot.target}</varname></para>
</listitem>
<listitem>
- <para>destroot.post_args default: none</para>
+ <para><literal>destroot.post_args</literal>, defaults to:
+ none</para>
</listitem>
<listitem>
<para>Examples:</para>
- <programlisting>destroot.pre_args -project AudioSlicer.xcode
-destroot.post_args INSTDIR=${destroot}${prefix}</programlisting>
+ <programlisting>destroot.pre_args -project AudioSlicer.xcode
+destroot.post_args INSTDIR=${destroot}${prefix}</programlisting>
</listitem>
</itemizedlist>
</listitem>
@@ -1916,9 +2291,9 @@
<term>destroot.target-delete</term>
<listitem>
- <para>Install target to pass to ${destroot.cmd}; list modifiers
- add or delete items from a previous Portfile destroot.target
- keyword or the default set by MacPorts base.</para>
+ <para>Install target to pass to <varname>${destroot.cmd}</varname>;
+ list modifiers add or delete items from a previous Portfile
+ destroot.target keyword or the default set by MacPorts base.</para>
<itemizedlist>
<listitem>
@@ -1928,30 +2303,33 @@
<listitem>
<para>Example:</para>
- <programlisting>destroot.target install install-config install-commandmode
-
-</programlisting>
+ <programlisting>destroot.target install install-config install-commandmode</programlisting>
+ <programlisting>destroot.target-append install-plugins
+destroot.target-delete install-commandmode</programlisting>
</listitem>
</itemizedlist>
</listitem>
-
- <listitem>
- <para>List modifier examples:</para>
-
- <programlisting>destroot.target-append install-plugins
-destroot.target-delete install-commandmode</programlisting>
- </listitem>
</varlistentry>
<varlistentry>
<term>destroot.destdir</term>
<listitem>
- <para>Arguments passed to ${destroot.cmd} to install correctly
- into the destroot.</para>
+ <para>Arguments passed to <varname>${destroot.cmd}</varname> to
+ install correctly into the destroot.</para>
- <programlisting>destroot.destdir prefix=${destroot}${prefix}</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>DESTDIR=${destroot}</literal></para>
+ </listitem>
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>destroot.destdir prefix=${destroot}${prefix}</programlisting>
+ </listitem>
+ </itemizedlist>
+
<note>
<para>If an application's Makefile properly supports the DESTDIR
variable, MacPorts will automatically destroot the port
@@ -1964,16 +2342,45 @@
</varlistentry>
<varlistentry>
+ <term>destroot.umask</term>
+
+ <listitem>
+ <para>Umask to use during destroot.</para>
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <literal>022</literal></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>destroot.umask 002</programlisting>
+ </listitem>
+ </itemizedlist>
+ </listitem>
+ </varlistentry>
+
+ <varlistentry>
<term>destroot.keepdirs</term>
<listitem>
<para>A list of directories that should not be removed if empty
upon destroot completion.</para>
- <programlisting>destroot.keepdirs \
- ${destroot}${prefix}/var/run \
- ${destroot}${prefix}/var/log \
- ${destroot}${prefix}/var/cache/mrtg</programlisting>
+ <itemizedlist>
+ <listitem>
+ <para>Default: ???</para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>destroot.keepdirs ${destroot}${prefix}/var/run \
+ ${destroot}${prefix}/var/log \
+ ${destroot}${prefix}/var/cache/mrtg</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
@@ -1982,10 +2389,22 @@
<listitem>
<para>MacPorts tests for compliance to the common directory
- structure in ${prefix}; the default is "no". If a port is not
+ structure in <varname>${prefix}</varname>. If a port is not
compliant with the standard, set it to "yes".</para>
- <programlisting>destroot.violate_mtree yes</programlisting>
+ <!-- TODO: add a link to the standard -->
+
+ <itemizedlist>
+ <listitem>
+ <para>Default: <option>no</option></para>
+ </listitem>
+
+ <listitem>
+ <para>Example:</para>
+
+ <programlisting>destroot.violate_mtree yes</programlisting>
+ </listitem>
+ </itemizedlist>
</listitem>
</varlistentry>
</variablelist>
Modified: trunk/doc-new/guide/xml/portfile-startupitem.7.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-startupitem.7.xml 2007-12-09 14:33:35 UTC (rev 31827)
+++ trunk/doc-new/guide/xml/portfile-startupitem.7.xml 2007-12-09 15:14:26 UTC (rev 31828)
@@ -26,7 +26,7 @@
<note>
<para>The variable <varname>startupitem_type</varname> in
- ${prefix}/etc/macports/macports.conf may be set to
+ <filename>${prefix}/etc/macports/macports.conf</filename> may be set to
<option>none</option> to globally override all StartupItem keywords
found in Portfiles; this prevents StartupItems from being
created.</para>
Modified: trunk/doc-new/guide/xml/portfileref.xml
===================================================================
--- trunk/doc-new/guide/xml/portfileref.xml 2007-12-09 14:33:35 UTC (rev 31827)
+++ trunk/doc-new/guide/xml/portfileref.xml 2007-12-09 15:14:26 UTC (rev 31828)
@@ -23,7 +23,7 @@
<xi:include href="portfile-tcl.7.xml"
xmlns:xi="http://www.w3.org/2001/XInclude" />
-
+<!--
<section id="reference.portgroup">
<title>PortGroup</title>
@@ -479,4 +479,5 @@
<para></para>
</section>
+-->
</chapter>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20071209/b68be4cb/attachment-0001.html
More information about the macports-changes
mailing list