[32903] trunk/doc-new/guide/xml
simon at macports.org
simon at macports.org
Mon Jan 14 13:58:20 PST 2008
Revision: 32903
http://trac.macosforge.org/projects/macports/changeset/32903
Author: simon at macports.org
Date: 2008-01-14 13:58:18 -0800 (Mon, 14 Jan 2008)
Log Message:
-----------
doc-new: Some fixes and improvements.
Modified Paths:
--------------
trunk/doc-new/guide/xml/portfile-phase.xml
trunk/doc-new/guide/xml/portfile-tcl.xml
trunk/doc-new/guide/xml/portfile-variants.xml
trunk/doc-new/guide/xml/project.xml
Modified: trunk/doc-new/guide/xml/portfile-phase.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-phase.xml 2008-01-14 21:26:33 UTC (rev 32902)
+++ trunk/doc-new/guide/xml/portfile-phase.xml 2008-01-14 21:58:18 UTC (rev 32903)
@@ -1114,7 +1114,8 @@
<term>use_configure</term>
<listitem>
- <para>Sets if the configure phase should be run.</para>
+ <para>Sets if the configure phase should be run. Can be used if the
+ port has no <filename>./configure</filename> script.</para>
<itemizedlist>
<listitem>
@@ -1141,8 +1142,9 @@
<para>Set environment variables for configure; list modifiers add
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>
+ use the predefined options (like <link
+ linkend="reference.phases.configure.cflags">configure.cflags</link>)
+ instead of modifying configure.env directly.</para>
<itemizedlist>
<listitem>
@@ -1162,7 +1164,7 @@
</listitem>
</varlistentry>
- <varlistentry>
+ <varlistentry id="reference.phases.configure.cflags">
<term>configure.cflags</term>
<term>configure.cflags-append</term>
@@ -1609,6 +1611,8 @@
and 10.4 PowerPC, <option>gcc-4.0</option> is available on 10.4
and 10.5, <option>gcc-4.2</option> is available as preview for
10.5.</para>
+ <para>Only use it if a port really needs a different
+ compiler.</para>
<itemizedlist>
<listitem>
@@ -1823,8 +1827,9 @@
<term>configure.post_args</term>
<listitem>
- <para>Main arguments to configure.cmd; optional argument modifiers
- pass arguments before and after the main arguments.</para>
+ <para>Main arguments to <literal>configure.cmd</literal>; optional
+ argument modifiers pass arguments before and after the main
+ arguments.</para>
<itemizedlist>
<listitem>
@@ -1868,7 +1873,7 @@
<title>Configure Universal</title>
<para>Universal keywords are used to make a port compile on the Mac OS X
- platform to run on either PPC or Intel.</para>
+ platform to run on both PPC and Intel processors.</para>
<note>
<para>There is a default universal variant made available to all ports
Modified: trunk/doc-new/guide/xml/portfile-tcl.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-tcl.xml 2008-01-14 21:26:33 UTC (rev 32902)
+++ trunk/doc-new/guide/xml/portfile-tcl.xml 2008-01-14 21:58:18 UTC (rev 32903)
@@ -186,7 +186,8 @@
<replaceable>directory</replaceable></term>
<listitem>
- <para>Create a directory.</para>
+ <para>Create a directory including parent directories if
+ necessary.</para>
</listitem>
</varlistentry>
</variablelist>
Modified: trunk/doc-new/guide/xml/portfile-variants.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-variants.xml 2008-01-14 21:26:33 UTC (rev 32902)
+++ trunk/doc-new/guide/xml/portfile-variants.xml 2008-01-14 21:58:18 UTC (rev 32903)
@@ -60,10 +60,10 @@
<term>default_variants</term>
<listitem>
- <para>The optional default_variants keyword is used to specify
- variants that a port author wishes to have enabled by default. This
- allows for Portfile modularity and also allows users to suppress
- default variants if they wish.</para>
+ <para>The optional <literal>default_variants</literal> keyword is
+ used to specify variants that a port author wishes to have enabled
+ by default. This allows for Portfile modularity and also allows
+ users to suppress default variants if they wish.</para>
<note>
<para>Due to a bug in the current MacPorts base default_variants
Modified: trunk/doc-new/guide/xml/project.xml
===================================================================
--- trunk/doc-new/guide/xml/project.xml 2008-01-14 21:26:33 UTC (rev 32902)
+++ trunk/doc-new/guide/xml/project.xml 2008-01-14 21:58:18 UTC (rev 32903)
@@ -40,8 +40,10 @@
<itemizedlist>
<listitem>
- <para><guilabel>Short Summary:</guilabel> [port] [version] [concise
- description]</para>
+ <para><guilabel>Short Summary:</guilabel>
+ <replaceable>[port]</replaceable>
+ <replaceable>[version]</replaceable> <replaceable>[concise
+ description]</replaceable></para>
<itemizedlist>
<listitem>
@@ -74,7 +76,11 @@
be relevant to someone reading the ticket. <ulink
url="http://trac.macports.org/projects/macports/wiki/WikiFormatting">Wiki
formatting</ulink> or attached log files should be used for large
- text blocks.</para>
+ text blocks. If you want to post a build log make sure you use
+ <literal>{{{<replaceable>...</replaceable>}}}</literal> around the
+ log or it could break the page layout (i.e.
+ <literal>{{{<replaceable>your build log
+ here</replaceable>}}}</literal>).</para>
</listitem>
<listitem>
@@ -148,7 +154,11 @@
email address and the maintainer's email address to notify both
parties when updates to the ticket occur. This is important, because
Trac currently only sends emails to addresses on the Cc list, not to
- the reporter or the assignee.</para>
+ the reporter or the assignee. Multiple emails should be separated
+ with a comma (i.e. <literal>you at example.org,
+ maintainer at macports.org</literal>). To get the maintainer email
+ address use <code>port info
+ <replaceable>portname</replaceable></code>.</para>
</listitem>
<listitem>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: http://lists.macosforge.org/pipermail/macports-changes/attachments/20080114/213cf0fd/attachment-0001.html
More information about the macports-changes
mailing list