[134587] trunk/doc-new/guide/xml
ionic at macports.org
ionic at macports.org
Mon Mar 30 17:39:17 PDT 2015
Revision: 134587
https://trac.macports.org/changeset/134587
Author: ionic at macports.org
Date: 2015-03-30 17:39:17 -0700 (Mon, 30 Mar 2015)
Log Message:
-----------
doc-new/guide/xml: indentation and whitespace fixes.
Modified Paths:
--------------
trunk/doc-new/guide/xml/internals.xml
trunk/doc-new/guide/xml/macports.conf.xml
trunk/doc-new/guide/xml/portfile-dependencies.xml
trunk/doc-new/guide/xml/portfile-keywords.xml
trunk/doc-new/guide/xml/portfile-phase.xml
trunk/doc-new/guide/xml/portfiledev.xml
trunk/doc-new/guide/xml/portgroups.xml
trunk/doc-new/guide/xml/project.xml
Modified: trunk/doc-new/guide/xml/internals.xml
===================================================================
--- trunk/doc-new/guide/xml/internals.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/internals.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -649,5 +649,5 @@
</variablelist>
</section>
</section>
-
+
</chapter>
Modified: trunk/doc-new/guide/xml/macports.conf.xml
===================================================================
--- trunk/doc-new/guide/xml/macports.conf.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/macports.conf.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -90,7 +90,7 @@
<para>Default: <option>sqlite</option></para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>build_arch</term>
@@ -108,8 +108,8 @@
<term>applications_dir</term>
<listitem>
- <para>Directory to install MacPorts that install OS X .app
- bundles.</para>
+ <para>Directory to install MacPorts that install OS X .app
+ bundles.</para>
<para>Default: <filename>/Applications/MacPorts</filename></para>
</listitem>
@@ -125,7 +125,7 @@
<filename>${prefix}/Library/Frameworks</filename></para>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>developer_dir</term>
@@ -299,9 +299,9 @@
<listitem>
<para>Space separated list of download hosts that should not be used.</para>
-
+
<para>Default: none</para>
-
+
<note>
<para>This feature is especially useful if a host turns out to be consistently
slow and therefore should be excluded for MacPorts' actions.</para>
@@ -314,7 +314,7 @@
<listitem>
<para>Space separated list of download hosts that should be used preferentially.</para>
-
+
<para>Default: none</para>
</listitem>
</varlistentry>
@@ -325,7 +325,7 @@
<listitem>
<para>Controls whether the rev-upgrade action will be run automatically after
upgrading ports.</para>
-
+
<para>Default: yes</para>
</listitem>
</varlistentry>
@@ -338,7 +338,7 @@
can rebuild ports to fix it. 'rebuild' means ports will automatically be rebuilt
when broken linking is detected in their files, while 'report' means broken
files will be scanned for and reported but the ports will not be rebuilt.</para>
-
+
<para>Default: rebuild</para>
</listitem>
</varlistentry>
Modified: trunk/doc-new/guide/xml/portfile-dependencies.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-dependencies.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/portfile-dependencies.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -140,18 +140,18 @@
programs, <option>lib</option> for libraries, and <option>path</option>
for any installed file. File dependencies are specified in the form:
<replaceable><type></replaceable>:<replaceable><filespec></replaceable>:<replaceable><port></replaceable>.</para>
-
+
<para>For <option>bin</option> dependencies,
<replaceable><filespec></replaceable> is the name of a program in a
bin directory like <filename>${prefix}/bin</filename>, /usr/bin, /bin, and
the associated sbin directories.</para>
-
+
<para>For <option>lib</option> dependencies,
<replaceable><filespec></replaceable> is the name of a library
(but without its extension) in a lib directory like
<filename>${prefix}/lib</filename>, /usr/lib, /lib, some Framework
directories, and those found in environment variables like DYLD_LIBRARY_PATH.</para>
-
+
<para>For <option>path</option> dependencies,
<replaceable><filespec></replaceable> is the complete absolute path
to the file, or more usually, when the file is inside
Modified: trunk/doc-new/guide/xml/portfile-keywords.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-keywords.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/portfile-keywords.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -226,14 +226,14 @@
sub-list.
</para>
- <para>If the version number is a
- <quote>.0</quote> version, the <quote>.0</quote> should be
- omitted to make the version an integer. If the author gives the choice
- of using a given license or <quote>any later version</quote> of it,
- append a plus sign (+) to the version number. If the version
- specified in this case is also the earliest version,
- just leave out the version number entirely since it implies all
- versions.</para>
+ <para>If the version number is a
+ <quote>.0</quote> version, the <quote>.0</quote> should be
+ omitted to make the version an integer. If the author gives the choice
+ of using a given license or <quote>any later version</quote> of it,
+ append a plus sign (+) to the version number. If the version
+ specified in this case is also the earliest version,
+ just leave out the version number entirely since it implies all
+ versions.</para>
<programlisting>license GPL-3</programlisting>
<programlisting>license {freetype GPL}</programlisting>
Modified: trunk/doc-new/guide/xml/portfile-phase.xml
===================================================================
--- trunk/doc-new/guide/xml/portfile-phase.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/portfile-phase.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -1088,7 +1088,7 @@
</itemizedlist>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>extract.suffix</term>
@@ -2070,7 +2070,7 @@
<para>Default: <option>gcc-4.0</option> on Mac OS X 10.4 and
10.5</para>
</listitem>
-
+
<listitem>
<para>Default: <option>gcc-4.2</option> with Xcode 3.2 on Mac OS X 10.6</para>
</listitem>
@@ -2847,7 +2847,7 @@
</itemizedlist>
</listitem>
</varlistentry>
-
+
<varlistentry>
<term>build.jobs</term>
@@ -2867,7 +2867,7 @@
</itemizedlist>
</listitem>
</varlistentry>
-
+
</variablelist>
</section>
Modified: trunk/doc-new/guide/xml/portfiledev.xml
===================================================================
--- trunk/doc-new/guide/xml/portfiledev.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/portfiledev.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -681,7 +681,7 @@
+++ src/Makefile.in 2007-06-20 10:10:59.000000000 -0700
@@ -131,23 +131,23 @@
$(INSTALL_DATA)/gdata $(INSTALL_DATA)/perl
-
+
install-lib:
- -mkdir -p $(INSTALL_LIB)
+ -mkdir -p $(DESTDIR)$(INSTALL_LIB)
@@ -858,14 +858,14 @@
<programlisting>checksums rmd160 7bbfce4fecc2a8e1ca081169e70c1a298ab1b75a \
sha256 2829fcb7393bac85925090b286b1f9c3cd3fbbf8e7f35796ef4131322509aa53</programlisting>
-
+
<para>Should a key item such as a phase or variant require braces, the
opening brace should appear on the same line and the closing brace should
be on its own line. The block formed by the braces is indented for visual
clearance. Braces merely quoting strings, for example the description of
variants, are placed on the same line without line breaks.</para>
- <programlisting>variant mysql5 description {Enable support for MySQL 5} {
+ <programlisting>variant mysql5 description {Enable support for MySQL 5} {
depends_lib-append port:mysql5
configure.args-replace --without-mysql5 --with-mysql5
}</programlisting>
@@ -916,22 +916,22 @@
<para>If there is the need to replace a port with another port or a
renaming is necessary for some reason, the port should be marked as
<code>replaced_by</code>.</para>
-
+
<para>As an illustration of a typical workflow the port
<quote>skrooge-devel</quote> shall be taken. This port had been used for
testing new versions of skrooge, but it turned out to have become
unnecessary due to the fact that skrooge's developers currently prefer a
distribution via port <quote>skrooge</quote> instead. </para>
-
+
<para>At the end of this section the use of the obsolete PortGroup is suggested
as an even shorter approach to the below described workflow.</para>
<section id="development.replaced_by">
- <title>The long way</title>
+ <title>The long way</title>
- <para>Skrooge's original devel port file looked like this:</para>
+ <para>Skrooge's original devel port file looked like this:</para>
-<programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
+ <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
# $Id$
PortSystem 1.0
@@ -969,58 +969,58 @@
port:kdebase4-runtime \
port:oxygen-icons</programlisting>
- <para>The following steps have to be taken to ensure a smooth transition
- for a MacPorts user updating his local installation using
- <userinput>sudo port upgrade</userinput>:</para>
+ <para>The following steps have to be taken to ensure a smooth transition
+ for a MacPorts user updating his local installation using
+ <userinput>sudo port upgrade</userinput>:</para>
- <orderedlist>
- <listitem>
- <para> add the line <code>replaced_by foo</code> where foo is the
- port this one is replaced by; when a user upgrades this port,
- MacPorts will instead install the replacement port</para>
- <programlisting>replaced_by skrooge</programlisting>
- </listitem>
+ <orderedlist>
+ <listitem>
+ <para> add the line <code>replaced_by foo</code> where foo is the
+ port this one is replaced by; when a user upgrades this port,
+ MacPorts will instead install the replacement port</para>
+ <programlisting>replaced_by skrooge</programlisting>
+ </listitem>
- <listitem>
- <para> increase the version, revision, or epoch, so that users who
- have this port installed will get notice in <code>port
- outdated</code> that they should upgrade it and trigger the above
- process</para>
- <programlisting>revision 1</programlisting>
- </listitem>
+ <listitem>
+ <para> increase the version, revision, or epoch, so that users who
+ have this port installed will get notice in <code>port
+ outdated</code> that they should upgrade it and trigger the above
+ process</para>
+ <programlisting>revision 1</programlisting>
+ </listitem>
- <listitem>
- <para> clear distfiles (have a line reading only
- <code>distfiles</code>) so that no distfile is downloaded for this
- stub port</para>
- <programlisting>distfiles</programlisting>
- </listitem>
+ <listitem>
+ <para> clear distfiles (have a line reading only
+ <code>distfiles</code>) so that no distfile is downloaded for this
+ stub port</para>
+ <programlisting>distfiles</programlisting>
+ </listitem>
- <listitem>
- <para> delete master_sites since there aren't any distfiles to
- download</para>
- </listitem>
+ <listitem>
+ <para> delete master_sites since there aren't any distfiles to
+ download</para>
+ </listitem>
- <listitem>
- <para> disable livecheck</para>
- <programlisting>livecheck.type none</programlisting>
- </listitem>
+ <listitem>
+ <para> disable livecheck</para>
+ <programlisting>livecheck.type none</programlisting>
+ </listitem>
- <listitem>
- <para> add a pre-configure block with a <code>ui_error</code> and
- <code>return -code error</code> explaining to users who try to
- install this port that the port has been replaced</para>
- <programlisting>pre-configure {
+ <listitem>
+ <para> add a pre-configure block with a <code>ui_error</code> and
+ <code>return -code error</code> explaining to users who try to
+ install this port that the port has been replaced</para>
+ <programlisting>pre-configure {
ui_error "Please do not install this port since it has been replaced by 'skrooge'."
return -code error
}</programlisting>
- </listitem>
- </orderedlist>
+ </listitem>
+ </orderedlist>
- <para>With above modifications the port file eventually looks like
- this:</para>
+ <para>With above modifications the port file eventually looks like
+ this:</para>
-<programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
+ <programlisting># -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
# $Id$
PortSystem 1.0
@@ -1053,10 +1053,10 @@
distfiles</programlisting>
- <para>A user upgrading ports will experience the following for port
- <quote>skrooge-devel</quote>:</para>
- <programlisting><prompt>%%</prompt> <userinput>sudo port upgrade skrooge-devel</userinput></programlisting>
- <screen>---> skrooge-devel is replaced by skrooge
+ <para>A user upgrading ports will experience the following for port
+ <quote>skrooge-devel</quote>:</para>
+ <programlisting><prompt>%%</prompt> <userinput>sudo port upgrade skrooge-devel</userinput></programlisting>
+ <screen>---> skrooge-devel is replaced by skrooge
---> Computing dependencies for skrooge
---> Fetching skrooge
---> Verifying checksum(s) for skrooge
@@ -1075,7 +1075,7 @@
# To start it run the following command:
# launchctl load /Library/LaunchAgents/org.freedesktop.dbus-session.plist
##########################################################
-
+
######################################################
# Programs will not start until you run the command
# 'sudo chown -R $USER ~/Library/Preferences/KDE'
@@ -1083,11 +1083,11 @@
######################################################
---> Cleaning skrooge</screen>
- <para>In case a user actually tries to install the obsolete port
- <quote>skrooge-devel</quote> it would be pointed out by an error message that
- this is impossible now:</para>
- <programlisting><prompt>%%</prompt> <userinput>sudo port install skrooge-devel</userinput></programlisting>
- <screen>---> Fetching skrooge-devel
+ <para>In case a user actually tries to install the obsolete port
+ <quote>skrooge-devel</quote> it would be pointed out by an error message that
+ this is impossible now:</para>
+ <programlisting><prompt>%%</prompt> <userinput>sudo port install skrooge-devel</userinput></programlisting>
+ <screen>---> Fetching skrooge-devel
---> Verifying checksum(s) for skrooge-devel
---> Extracting skrooge-devel
---> Configuring skrooge-devel
@@ -1097,15 +1097,15 @@
Error: Status 1 encountered during processing.
To report a bug, see <http://guide.macports.org/#project.tickets></screen>
- </section>
+ </section>
- <section id="development.obsolete-portgroup">
- <title>The shortcut: PortGroup obsolete</title>
+ <section id="development.obsolete-portgroup">
+ <title>The shortcut: PortGroup obsolete</title>
- <para>Using the PortGroup obsolete makes the task described in the previous subsection
- much easier:</para>
+ <para>Using the PortGroup obsolete makes the task described in the previous subsection
+ much easier:</para>
- <programlisting>
+ <programlisting>
# -*- coding: utf-8; mode: tcl; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4; truncate-lines: t -*- vim:fenc=utf-8:et:sw=4:ts=4:sts=4
# $Id$
PortSystem 1.0
@@ -1116,70 +1116,69 @@
version 0.8.0-${svn.revision}
revision 2</programlisting>
- <para>The PortGroup defines a number of reasonable defaults for a port that is only
- there to inform users that they should uninstall it and install something else
- instead. You might want to override some of the defaults though. For details have
- a look at the PortGroup's source code in
- <filename>${prefix}/var/macports/sources/rsync.macports.org/release/ports/_resources/port1.0/group/obsolete-1.0.tcl</filename>.</para>
+ <para>The PortGroup defines a number of reasonable defaults for a port that is only
+ there to inform users that they should uninstall it and install something else
+ instead. You might want to override some of the defaults though. For details have
+ a look at the PortGroup's source code in
+ <filename>${prefix}/var/macports/sources/rsync.macports.org/release/ports/_resources/port1.0/group/obsolete-1.0.tcl</filename>.</para>
- <note>
- <para>It is important to specify <varname>replaced_by</varname> BEFORE the
+ <note>
+ <para>It is important to specify <varname>replaced_by</varname> BEFORE the
<varname>PortGroup</varname> line!</para>
- </note>
+ </note>
- </section>
+ </section>
</section>
-
-
+
<section id="development.practices.removing-port">
<title>Removing a port</title>
<para>If a port has to be removed from MacPorts one should consider
- the hints concerning replacing it by some alternative port given
- <link linkend="development.practices.rename-replace-port">above</link>.
- It is recommended to wait one year before the port directory
- is actually removed from MacPorts' Subversion repository.
+ the hints concerning replacing it by some alternative port given
+ <link linkend="development.practices.rename-replace-port">above</link>.
+ It is recommended to wait one year before the port directory
+ is actually removed from MacPorts' Subversion repository.
</para>
<para>If there is no replacement for a port, it can simply be deleted
- immediately.</para>
-
- </section>
-
+ immediately.</para>
+
+ </section>
+
</section>
<section id="development.buildbot">
- <title>MacPorts' buildbot</title>
+ <title>MacPorts' buildbot</title>
- <para>The <ulink url="https://build.macports.org/">buildbot</ulink> is a port
+ <para>The <ulink url="https://build.macports.org/">buildbot</ulink> is a port
build-service currently supporting building of all committed ports for Snow Leopard,
Lion, and Mountain Lion using the MacPorts AutoBuild
(<ulink url="http://svn.macports.org/repository/macports/contrib/mpab/">MPAB</ulink>)
scripts.</para>
-
- <para>Every time a maintainer commits changes to MacPorts' central SVN repository
+
+ <para>Every time a maintainer commits changes to MacPorts' central SVN repository
the buildbot will check whether a rebuild of the corresponding port(s) would
be necessary. If the port(s) in question are distributable their binary
archives will be kept for subsequent distribution for the three most current
versions of the OS X operating system.</para>
-
- <para>If a build error occurred for a port its maintainer will be informed via
+
+ <para>If a build error occurred for a port its maintainer will be informed via
an email so that problems which did not surface on the maintainer's machine will
not go unnoticed.
-
+
Port maintainers will find the
<ulink url="https://build.macports.org/waterfall">waterfall</ulink>
- and the
+ and the
<ulink url="https://build.macports.org/builders">builders</ulink>
views most useful since they give information about the build status and offer
the possibility to build ones port(s) on specific builders.</para>
-
- <para>Thus the buildbot helps to keep MacPorts consistent on various
+
+ <para>Thus the buildbot helps to keep MacPorts consistent on various
OSX versions, i.e., a maintainer does not need access to these versions anymore in
order to assure that the port(s) maintained build without problems. Currently only
the default port variants will be built and kept.</para>
</section>
-
+
</chapter>
Modified: trunk/doc-new/guide/xml/portgroups.xml
===================================================================
--- trunk/doc-new/guide/xml/portgroups.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/portgroups.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -38,5 +38,5 @@
comments in the header of the portgroup file itself) should provide guidance on how each
portgroup is used. Prospective MacPorts developers are also encouraged to examine existing
portfiles that use these portgroups.</para>
-
+
</section>
Modified: trunk/doc-new/guide/xml/project.xml
===================================================================
--- trunk/doc-new/guide/xml/project.xml 2015-03-31 00:39:07 UTC (rev 134586)
+++ trunk/doc-new/guide/xml/project.xml 2015-03-31 00:39:17 UTC (rev 134587)
@@ -164,19 +164,19 @@
patches, created to enhance something that isn't failing its
intended purpose.</para>
</listitem>
-
+
<listitem>
<para><guimenu>update</guimenu> - Tickets, with or without
patches, involving updating a port to a newer upstream
version.</para>
</listitem>
-
+
<listitem>
<para><guimenu>submission</guimenu> - Tickets created to submit
Portfiles for software not currently available in MacPorts.
</para>
</listitem>
-
+
<listitem>
<para><guimenu>request</guimenu> - Tickets created to request
the creation of a new port.</para>
@@ -280,7 +280,7 @@
development of the ticket. Multiple email addresses should be
separated with a comma and a space
(e.g., <literal>you at example.org, maintainer at macports.org</literal>).</para>
-
+
<para>When reporting port-related tickets, make sure you add the
port maintainers email address to the <guilabel>Cc:</guilabel> field
so they are notified of the ticket (unless you have commit access,
@@ -289,12 +289,12 @@
<literal>port info --maintainers <replaceable>[port]</replaceable>
</literal></para>
</listitem>
-
+
<listitem>
<para><guilabel>Assign To:</guilabel> Only users with commit access
can edit this field. If this is not you, see the section on the
<guimenu>Cc</guimenu> field above.</para>
-
+
<para>For tickets on ports, enter
the email address of the port's maintainer (use <command>port info
<portname></command> to find this). If multiple maintainers
@@ -787,9 +787,9 @@
<para>In the Description field, refer to any unacknowledged ticket(s).</para>
</listitem>
- <listitem>
- <para>In the Port field, indicate which port is abandoned.</para>
- </listitem>
+ <listitem>
+ <para>In the Port field, indicate which port is abandoned.</para>
+ </listitem>
<listitem>
<para>The Port Abandoned ticket may be closed when the new
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.macosforge.org/pipermail/macports-changes/attachments/20150330/e96a8a5f/attachment-0001.html>
More information about the macports-changes
mailing list