[jhbuild/desrt/master: 5/14] docs: clarify 'suggests' and 'after'
- From: Ryan Lortie <desrt src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [jhbuild/desrt/master: 5/14] docs: clarify 'suggests' and 'after'
- Date: Sat, 17 Jan 2015 22:27:46 +0000 (UTC)
commit 5fb9a6931ac093a0d5b765eb3fcf6b3ff6d2edcf
Author: Ryan Lortie <desrt desrt ca>
Date: Sat Jan 10 21:12:12 2015 -0500
docs: clarify 'suggests' and 'after'
Clarify the documentation for what <suggests/> and <after/> do, as well
as adding documentation for the new 'ignore_after' config option.
https://bugzilla.gnome.org/show_bug.cgi?id=693290
doc/C/index.docbook | 30 ++++++++++++++++++++++++------
1 files changed, 24 insertions(+), 6 deletions(-)
---
diff --git a/doc/C/index.docbook b/doc/C/index.docbook
index 413befe..378c615 100644
--- a/doc/C/index.docbook
+++ b/doc/C/index.docbook
@@ -1778,12 +1778,24 @@ Optional packages: (JHBuild will build the missing packages)
installation to reduce the time taken for rebuilds.</simpara>
</listitem>
</varlistentry>
+ <varlistentry id="cfg-ignore-after">
+ <term>
+ <varname>ignore_after</varname>
+ </term>
+ <listitem>
+ <simpara>A boolean value specifying whether to ignore
+ <sgmltag class="element">after</sgmltag>
+ dependencies when calculating the dependency tree. Defaults to
+ <constant>False</constant>.</simpara>
+ </listitem>
+ </varlistentry>
<varlistentry id="cfg-ignore-suggests">
<term>
<varname>ignore_suggests</varname>
</term>
<listitem>
- <simpara>A boolean value specifying whether to ignore soft
+ <simpara>A boolean value specifying whether to ignore
+ <sgmltag class="element">suggests</sgmltag>
dependencies when calculating the dependency tree. Defaults to
<constant>False</constant>.</simpara>
</listitem>
@@ -2756,11 +2768,17 @@ Optional packages: (JHBuild will build the missing packages)
the module list for <command>jhbuild build</command> if it isn't already
included, and make sure the dependent modules are built first.</para>
- <para>After generating the modules list, the modules listed in the
- <sgmltag class="element">suggests</sgmltag> element will be used to
- further sort the modules list (although it will not pull any additional
- modules). This is intended for cases where a module has an optional
- dependency on another module.</para>
+ <para>Modules listed in the <sgmltag class="element">suggests</sgmltag>
+ element will also be added unless you set the
+ <link linkend="cfg-ignore-suggests"><varname>ignore_suggests</varname></link>
+ configuration option.</para>
+
+ <para>Modules listed in the <sgmltag class="element">after</sgmltag>
+ element will also be added, after the module is built. This can be useful
+ for cases where other modules provide plugins to extend functionality. This
+ can be disabled using the
+ <link linkend="cfg-ignore-after"><varname>ignore_after</varname></link>
+ configuration option.</para>
<section id="moduleset-syntax-defs-autotools">
<title>autotools</title>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]