From 2fd5f1897a0783cf36e5a5f78f6c52be0c72be33 Mon Sep 17 00:00:00 2001 From: Craig Keogh Date: Fri, 4 Sep 2009 22:23:01 +0930 Subject: [PATCH] [doc] Provide examples in section Configuration File Reference --- doc/C/jhbuild.xml | 80 ++++++++++++++++++++++++------------------------------- 1 file changed, 35 insertions(+), 45 deletions(-) diff --git a/doc/C/jhbuild.xml b/doc/C/jhbuild.xml index 11029e3a..876b4f2b 100644 --- a/doc/C/jhbuild.xml +++ b/doc/C/jhbuild.xml @@ -434,7 +434,7 @@ prefix = os.path.join(os.environ['HOME'], 'prefix') All Buildbot-related commands are options of the bot, downloading and installing the extra required - softwares is done like this: + software is done like this: $ jhbuild bot --setup @@ -1269,6 +1269,22 @@ libgnomecanvas is missing branch definition for gnome-2-20 set of default values are inserted into the namespace before running the user's configuration file. + Boolean configuration variables are set using syntax as + demonstrated in the following example: + use_local_modulesets = True + + String configuration variables are set using syntax as + demonstrated in the following example: + autogenargs = '--disable-static --disable-gtk-doc' + + List configuration variables are set using syntax as + demonstrated in the following example: + skip = ['mozilla', 'pulseaudio'] + + Dictionary configuration variables are set using syntax as + demonstrated in the following example: + repos['git.gnome.org'] = 'ssh://cskeogh@git.gnome.org/git/' +
Configuration Variables @@ -1277,7 +1293,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 alwaysautogen - If set to True, then always + A boolean value if set to True, always run autogen.sh before make, even if a makefile exists. This is equivalent to passing @@ -1290,7 +1306,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 A string containing arguments passed to the autogen.sh script of all modules. Can - be overriden for particular modules using the + be overridden for particular modules using the module_autogenargs dictionary. @@ -1380,18 +1396,6 @@ libgnomecanvas is missing branch definition for gnome-2-20 - cvsroots - - A dictionary that can be used to change the CVS - roots used to check out source code. If you have a CVS - account for a particular project, you can set the - associated key to use that account rather than the - anonymous account. For example, you might want to set - 'gnome.org' to - ':ext:username@cvs.gnome.org:/cvs/gnome'. - - - cvs_program A string specifying which program to use for @@ -1535,7 +1539,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 moduleset - A string giving the name of the module set to + A string or list giving the name of the module set(s) to use. This can either be the filename of a moduleset included with JHBuild (excluding the path and extension), or a full HTTP URL to refer to an externally managed @@ -1652,15 +1656,14 @@ libgnomecanvas is missing branch definition for gnome-2-20 repos - By default, JHBuild will check out code from - repositories using an anonymous repository location. This - dictionary is used to tell JHBuild to use an alternative - repository location for a particular repository (a developer - would probably want to do this). This variable is a - dictionary where the keys are short repository names (for - example, - svn.gnome.org - is used for the GNOME SVN repository), and the values are the alternative repository location strings. + A dictionary that can be used to specify an alternative + repository location for a particular repository. This configuration + variable is useful to a module developer. By default, JHBuild will + check out code from repositories using an anonymous repository + location. The dictionary keys are short repository names and the + values are the alternative repository location strings. For example: + + repos['git.gnome.org'] = 'ssh://username@git.gnome.org/git/' @@ -1676,26 +1679,13 @@ libgnomecanvas is missing branch definition for gnome-2-20 sticky_date - If set, JHBuild will attempt to check out modules + A string if set, JHBuild will attempt to check out modules as they existed at the given date. The date should be given in the form 'yyyy-mm-dd'. Defaults to None. - - svnroots - - Similar to cvsroots but for - Subversion repositories; a dictionary that can be used to - change the Subversion roots used to check out source code. - If you have a Subversion account for a particular project, - you can set the associated key to use that account rather - than the anonymous account. For example, you might want to - set 'svn.gnome.org' to - 'svn+ssh://username@svn.gnome.org:/svn'. - - svn_program @@ -1708,7 +1698,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 tarballdir - If set, tarballs will be downloaded to this + A string if set, tarballs will be downloaded to this directory instead of checkoutroot. This is useful if you have multiple JHBuild environments or regularly clear out your @@ -1730,7 +1720,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 trycheckout - A boolean option which if set to + A boolean value which if set to True, causes JHBuild to automatically try to solve failures by 1) running autogen.sh again, and 2) checking out a newer version of a module from version @@ -2048,7 +2038,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 The size and hash, as well as the obsolete - md5sum, attributes are optional. + md5sum, attributes are optional. If these attributes are present, they are used to check that the source package was downloaded correctly. @@ -2060,7 +2050,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 many levels of directories to prune when applying the patch. - For module sets shipped with JHbuild, the patch files are + For module sets shipped with JHuild, the patch files are looked up in the jhbuild/patches/ directory; for module sets referred by URI, the patch files are looked for in the same directory as the moduleset file, or in its @@ -2620,7 +2610,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 class="attribute">href attribute is mandatory, while the size and hash, as well as the obsolete - md5sum, attributes are optional. + md5sum, attributes are optional. If these last two attributes are present, they are used to check that the source package was downloaded correctly. @@ -2632,7 +2622,7 @@ libgnomecanvas is missing branch definition for gnome-2-20 many levels of directories to prune when applying the patch. - For module sets shipped with JHbuild, the patch files are + For module sets shipped with JHBuild, the patch files are looked up in the jhbuild/patches/ directory; for module sets referred by URI, the patch files are looked for in the same directory as the moduleset file, or in its -- 2.11.4.GIT