[103910] branches/new-help-system/base/doc
raimue at macports.org
raimue at macports.org
Sat Mar 9 16:52:50 PST 2013
Revision: 103910
https://trac.macports.org/changeset/103910
Author: raimue at macports.org
Date: 2013-03-09 16:52:50 -0800 (Sat, 09 Mar 2013)
Log Message:
-----------
doc:
Use second-level labeled lists for default values and similar information.
Using + at the end of line in AsciiDoc syntax generates the processing
instruction <?asciidoc-br?> that does not work with the manpage stylesheets
from docbook-xsl.
Modified Paths:
--------------
branches/new-help-system/base/doc/macports.conf.5.txt
branches/new-help-system/base/doc/portgroup.7.txt
Modified: branches/new-help-system/base/doc/macports.conf.5.txt
===================================================================
--- branches/new-help-system/base/doc/macports.conf.5.txt 2013-03-10 00:48:57 UTC (rev 103909)
+++ branches/new-help-system/base/doc/macports.conf.5.txt 2013-03-10 00:52:50 UTC (rev 103910)
@@ -24,147 +24,150 @@
KEYS
----
+// Set default style for second-level labeled lists in this section
+:listdef-labeled2.style: horizontal
+
The following keys are used by *port* itself:
prefix::
Sets the directory where ports are installed. Any path may be used but those
with spaces and/or non ascii characters should be avoided, as this can break
- some ports. This key is often referred to as '$\{prefix\}'. +
- **Default:** /opt/local
+ some ports. This key is often referred to as '$\{prefix\}'.
+ *Default:*;; /opt/local
portdbpath::
Directory where MacPorts keeps working data such as downloaded sources,
installed ports' receipts and the main registry. The same path restrictions
- apply as for '$\{prefix\}'. +
- *Default:* $\{prefix\}/var/macports
+ apply as for '$\{prefix\}'.
+ *Default:*;; $\{prefix\}/var/macports
portdbformat::
Storage type to use for the MacPorts registry. The preferred format is
- "sqlite", with "flat" also available as a legacy format. +
- *Default:* sqlite
+ "sqlite", with "flat" also available as a legacy format.
+ *Default:*;; sqlite
applications_dir::
- Directory containing Applications installed from ports. +
- *Default:* /Applications/MacPorts
+ Directory containing Applications installed from ports.
+ *Default:*;; /Applications/MacPorts
frameworks_dir::
- Directory containing Frameworks installed from ports. +
- *Default:* $\{prefix\}/Library/Frameworks
+ Directory containing Frameworks installed from ports.
+ *Default:*;; $\{prefix\}/Library/Frameworks
sources_conf::
Location of the sources file. This file enables rsync synchronization of the
default ports tree with the MacPorts rsync server (through the "sync" target
- of the port command) and any other local tree(s) you might have. +
- *Default:* $\{prefix\}/etc/macports/sources.conf
+ of the port command) and any other local tree(s) you might have.
+ *Default:*;; $\{prefix\}/etc/macports/sources.conf
variants_conf::
Location of the optional global variants definition file, listing those that
- should be used in all installed ports if available. +
- *Default:* $\{prefix\}/etc/macports/variants.conf
+ should be used in all installed ports if available.
+ *Default:*;; $\{prefix\}/etc/macports/variants.conf
buildfromsource::
Controls whether ports are built from source or downloaded as pre-built
archives. Setting to 'always' will never use archives, 'never' will always
try to use an archive and fail if one is not available. 'ifneeded' will try
to fetch an archive and fall back to building from source if that isn't
- possible. +
- *Default:* ifneeded
+ possible.
+ *Default:*;; ifneeded
portarchivetype::
Format of archives in which to store port images. This controls both the
type of archive cre- ated locally after building from source, and the type
to request from remote servers. Changing this will not affect the usability
- of already installed archives; they can be of any supported type. +
- *Supported types:* tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio +
- *Default:* tbz2
+ of already installed archives; they can be of any supported type.
+ *Supported types:*;; tgz, tar, tbz, tbz2, tlz, txz, xar, zip, cpgz, cpio
+ *Default:*;; tbz2
configureccache::
- Use ccache (C/C++ compiler cache). Requires that ccache has been installed. +
- *Default:* no
+ Use ccache (C/C++ compiler cache). Requires that ccache has been installed.
+ *Default:*;; no
ccache_dir::
- Location where ccache stores its files +
- *Default:* ${portdbpath}/build/.ccache
+ Location where ccache stores its files
+ *Default:*;; ${portdbpath}/build/.ccache
ccache_size::
Maximum size ccache may use. Use 'G', 'M', or 'K' suffix for giga-, mega- or
- kilobytes. +
- *Default:* 2G
+ kilobytes.
+ *Default:*;; 2G
configuredistcc::
- Use distcc (distributed compiler). Requires that distcc has been installed. +
- *Default:* no
+ Use distcc (distributed compiler). Requires that distcc has been installed.
+ *Default:*;; no
configurepipe::
Use pipes rather than intermediate files when compiling C/C++/etc (gcc
- -pipe) +
- *Default:* yes
+ -pipe)
+ *Default:*;; yes
buildnicevalue::
- Lowered scheduling priority (0-20) to use for make when building ports +
- *Default:* 0
+ Lowered scheduling priority (0-20) to use for make when building ports
+ *Default:*;; 0
buildmakejobs::
Number of simultaneous make jobs (commands) to use when building ports. 0 is
a special value meaning "the number of CPU cores or the number of GB of
- physical memory plus one, whichever is less." +
- *Default:* 0
+ physical memory plus one, whichever is less."
+ *Default:*;; 0
portautoclean::
Automatic cleaning of the build directory of a given port after it has been
- installed. +
- *Default:* yes
+ installed.
+ *Default:*;; yes
keeplogs::
- Keep logs for ports. +
- *Default:* no
+ Keep logs for ports.
+ *Default:*;; no
build_arch::
- The machine architecture to try to build for in normal use. +
- *Regular architectures include:* ppc, i386, ppc64, x86_64 +
- *Default (10.6):* x86_64 or i386 depending on hardware +
- *Default (10.5 and earlier):* i386 or ppc depending on hardware
+ The machine architecture to try to build for in normal use.
+ *Regular architectures include:*;; ppc, i386, ppc64, x86_64
+ *Default (10.6):*;; x86_64 or i386 depending on hardware
+ *Default (10.5 and earlier):*;; i386 or ppc depending on hardware
universal_archs::
- The machine architectures to use for +universal variant (multiple architecture
- entries should be space separated). +
- *Regular architectures include:* ppc, i386, ppc64, x86_64 +
- *Default (10.6):* x86_64 i386 +
- *Default (10.5 and earlier):* i386 ppc +
+ The machine architectures to use for +universal variant (multiple
+ architecture entries should be space separated).
+ *Regular architectures include:*;; ppc, i386, ppc64, x86_64
+ *Default (10.6):*;; x86_64 i386
+ *Default (10.5 and earlier):*;; i386 ppc
startupitem_type::
Set the default type of startupitems to be generated, overridable by
Portfiles that explicitly state a startupitem.type key. If set to "default",
- then a type will be selected that's appropriate to the OS. +
- *Supported types:* none, SystemStarter, launchd, default, rcNG. +
- *Default:* default
+ then a type will be selected that's appropriate to the OS.
+ *Supported types:*;; none, SystemStarter, launchd, default, rcNG.
+ *Default:*;; default
destroot_umask::
- Umask value to use during the destrooting of a port. +
- *Default:* 022
+ Umask value to use during the destrooting of a port.
+ *Default:*;; 022
rsync_server::
Default rsync server to connect to when running "selfupdate" through the
port com- mand to update your base MacPorts infrastructure. While selfupdate
also syncs the ports tree, it uses the settings from $\{sources_conf\} to do
- so. +
- *Default:* rsync.macports.org
+ so.
+ *Default:*;; rsync.macports.org
rsync_dir::
- Rsync directory from which to pull MacPorts sources from the rsync server. +
- *Default:* release/base/ (which pulls sources for the currently shipping
+ Rsync directory from which to pull MacPorts sources from the rsync server.
+ *Default:*;; release/base/ (which pulls sources for the currently shipping
MacPorts release)
rsync_options::
- Default rsync options to use when connecting to the rsync server. +
- *Default:* -rtzv --delete-after
+ Default rsync options to use when connecting to the rsync server.
+ *Default:*;; -rtzv --delete-after
binpath::
Sets the directory search path for locating system executables used by
MacPorts. This variable should contain the paths for locating utilities such
as rsync, tar, cvs and others. Don't change this unless you understand and
- accept the consequences. +
- *Default:* $\{prefix\}/bin:$\{prefix\}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
+ accept the consequences.
+ *Default:*;; $\{prefix\}/bin:$\{prefix\}/sbin:/bin:/sbin:/usr/bin:/usr/sbin
extra_env::
List of extra environment variables MacPorts should keep in the user's
@@ -179,56 +182,56 @@
have an rsync proxy definition. Also note, on 10.5, sudo will clear many
environment variables including those for proxy support. Equivalent
environment variables: http_proxy, HTTPS_PROXY, FTP_PROXY, RSYNC_PROXY,
- NO_PROXY +
- *Default:* yes
+ NO_PROXY
+ *Default:*;; yes
proxy_http::
- HTTP proxy +
- *Default:* none
+ HTTP proxy
+ *Default:*;; none
proxy_https::
- HTTPS proxy +
- *Default:* none
+ HTTPS proxy
+ *Default:*;; none
proxy_ftp::
- FTP proxy +
- *Default:* none
+ FTP proxy
+ *Default:*;; none
proxy_rsync::
- rsync proxy +
- *Default:* none
+ rsync proxy
+ *Default:*;; none
proxy_skip::
Hosts not to go through the proxy (comma-separated, applies to HTTP, HTTPS
- and FTP, but not rsync). +
- *Default:* none
+ and FTP, but not rsync).
+ *Default:*;; none
host_blacklist::
- Space separated list of download hosts that should not be used. +
- *Default:* none
+ Space separated list of download hosts that should not be used.
+ *Default:*;; none
preferred_hosts::
- Space separated list of download hosts that should be used preferentially. +
- *Default:* none
+ Space separated list of download hosts that should be used preferentially.
+ *Default:*;; none
revupgrade_autorun::
Controls whether the rev-upgrade action will be run automatically after
- upgrading ports. +
- *Default:* yes
+ upgrading ports.
+ *Default:*;; yes
revupgrade_mode::
Controls the rev-upgrade functionality which checks for broken linking and
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. +
- *Default:* rebuild
+ rebuilt.
+ *Default:*;; rebuild
default_compiler::
Default value for configure.compiler. This can be a space-separated list.
Later entries will be used if earlier entries are unavailable or blacklisted
- by a port. Setting this is unsupported. +
- *Default:* none (internal list based on Xcode version is normally used)
+ by a port. Setting this is unsupported.
+ *Default:*;; none (internal list based on Xcode version is normally used)
FILES
-----
Modified: branches/new-help-system/base/doc/portgroup.7.txt
===================================================================
--- branches/new-help-system/base/doc/portgroup.7.txt 2013-03-10 00:48:57 UTC (rev 103909)
+++ branches/new-help-system/base/doc/portgroup.7.txt 2013-03-10 00:52:50 UTC (rev 103910)
@@ -2,6 +2,8 @@
PortGroup(7)
============
$Id$
+// Set default style for second-level labeled lists in this document
+:listdef-labeled2.style: horizontal
NAME
----
@@ -59,63 +61,82 @@
Portfiles using *xcode PortGroup* may define the following variables:
xcode.project::
- Path (relative to ${build.dir} and ${destroot.dir}) of the Xcode project. If
- unset, let xcode tool figure it out. It usually succeeds if there is
- a single project in the directory. +
- *Type:* optional +
- *Example:* +
+ Path (relative to ${build.dir} and ${destroot.dir}) of the Xcode
+ project. If unset, let xcode tool figure it out. It usually succeeds if
+ there is a single project in the directory.
+
+--
+*Type:*;; optional
+--
++
+*Example:*
++
--------
xcode.project ${name}.xcode
--------
xcode.configuration::
- Project configuration/buildstyle to use. +
- *Type:* optional +
- *Default:* Deployment +
- *Example:* +
+ Project configuration/buildstyle to use.
+
+--
+*Type:*;; optional
+*Default:*;; Deployment
+--
++
+*Example:*
++
--------
xcode.configuration Main
--------
xcode.target::
- If present, overrides build.target and destroot.target. +
- *Type:* optional
+ If present, overrides build.target and destroot.target.
+ *Type:*;; optional
xcode.build.settings::
Additional settings passed to the xcode build tool during the build phase.
- These settings should be in the X=Y form. +
- *Type:* optional +
- *Example:* +
+ These settings should be in the X=Y form.
+
+--
+*Type:*;; optional
+--
++
+*Example:*
++
--------
xcode.build.settings FRAMEWORK_SEARCH_PATHS=${prefix}/Library/Frameworks
--------
xcode.destroot.type::
Type of project that will be installed. This tells Xcode PortGroup how to
- destroot the project. Correct values are application and framework. +
- *Type:* optional +
- *Default:* application +
- *Example:* +
+ destroot the project. Correct values are application and framework.
+
+--
+*Type:*;; optional
+*Default:*;; application
+--
++
+*Example:*
++
--------
xcode.destroot.type framework
--------
xcode.destroot.path::
- Where to install the build product. +
- *Type:* optional +
- *Default:* ${prefix}/Library/Frameworks or /Applications/MacPorts depending
- on xcode.destroot.type
+ Where to install the build product.
+ *Type:*;; optional
+ *Default:*;; ${prefix}/Library/Frameworks or /Applications/MacPorts depending on xcode.destroot.type
xcode.destroot.settings::
Additional settings passed to the xcode build tool during the destroot
- phase. These settings should be in the X=Y form. +
- *Type:* optional +
- *Example:* +
+ phase. These settings should be in the X=Y form.
+
+--
+*Type:*;; optional
+--
++
+*Example:*
++
--------
xcode.destroot.settings SKIP_INSTALL=NO
--------
@@ -139,20 +160,20 @@
building all targets. This variable will be ignored if xcode.target is set.
build.pre_args::
- Additional parameters for ${build.cmd}. +
- *Default:* none
+ Additional parameters for ${build.cmd}.
+ *Default:*;; none
build.args::
- Main parameters for ${build.cmd}. +
- *Default:* build
+ Main parameters for ${build.cmd}.
+ *Default:*;; build
build.post_args::
- Additional parameters for ${build.cmd}. +
- *Default:* none
+ Additional parameters for ${build.cmd}.
+ *Default:*;; none
build.dir::
- Where to build the project from (i.e. where the Xcode project is). +
- *Default:* ${worksrcpath}
+ Where to build the project from (i.e. where the Xcode project is).
+ *Default:*;; ${worksrcpath}
destroot.cmd::
The command to invoke to destroot the project. *xcode PortGroup* sets this
@@ -164,20 +185,20 @@
is set.
destroot.pre_args::
- Additional parameters for ${destroot.cmd}. +
- *Default:* none
+ Additional parameters for ${destroot.cmd}.
+ *Default:*;; none
destroot.args::
- Main parameters for ${destroot.cmd}. +
- *Default:* install
+ Main parameters for ${destroot.cmd}.
+ *Default:*;; install
destroot.post_args::
- Additional parameters for ${destroot.cmd}. +
- *Default:* none
+ Additional parameters for ${destroot.cmd}.
+ *Default:*;; none
destroot.dir::
- Where to destroot the project from (i.e. where the Xcode project is). +
- *Default:* ${worksrcpath}
+ Where to destroot the project from (i.e. where the Xcode project is).
+ *Default:*;; ${worksrcpath}
GNUSTEP PORTGROUP
-----------------
@@ -261,10 +282,14 @@
an associative array which specifies the sub-directories relative to
${worksrcpath} and the SHARED_LD_POSTFLAGS variables to be added to
GNUmakefile.preamble in those sub-directories. This helps making the
- patching process easier on Darwin. +
- *Type:* optional +
- *Example:* +
+ patching process easier on Darwin.
+
+--
+*Type:*;; optional
+--
++
+*Example:*
++
--------
platform darwin {
array set gnustep.post_flags {
@@ -274,10 +299,14 @@
--------
gnustep.cc::
- *Type:* optional +
- *Default:* gcc-mp-4.2 +
- *Example:* +
+
+--
+*Type:*;; optional
+*Default:*;; gcc-mp-4.2
+--
++
+*Example:*
++
--------
gnustep.cc gcc-mp-4.3
--------
@@ -285,10 +314,14 @@
variant with_docs::
Many GNUstep packages include a Documentation sub-directory that is not
built by default. Enabling this variant builds and installs the included
- documentation. +
- *Type:* optional +
- *Example:* +
+ documentation.
+
+--
+*Type:*;; optional
+--
++
+*Example:*
++
--------
port install gnustep-gui +with_docs
--------
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.macosforge.org/pipermail/macports-changes/attachments/20130309/4991a504/attachment.html>
More information about the macports-changes
mailing list