jhbuild r1846 - in trunk: . doc/C

[fpeters svn gnome org]

Author: fpeters
Date: Fri Jan 18 21:37:29 2008
New Revision: 1846
URL: http://svn.gnome.org/viewvc/jhbuild?rev=1846&view=rev

Log:
* doc/C/jhbuild.xml: updated documentation to also list build systems
that are supported, and to add some more consistency in how JHBuild is
spelt.



Modified:
   trunk/ChangeLog
   trunk/doc/C/jhbuild.xml

Modified: trunk/doc/C/jhbuild.xml
==============================================================================
--- trunk/doc/C/jhbuild.xml	(original)
+++ trunk/doc/C/jhbuild.xml	Fri Jan 18 21:37:29 2008
@@ -63,42 +63,18 @@
     provide build rules independent of JHBuild.</para>
 
     <para>JHBuild can build modules from a variety of sources,
-    including:</para>
-
-    <itemizedlist>
-      <listitem>
-	<simpara><ulink url="http://www.cvshome.org/";>CVS</ulink>
-	repositories</simpara>
-      </listitem>
-      <listitem>
-	<simpara><ulink
-	url="http://subversion.tigris.org/";>Subversion</ulink>
-	repositories</simpara>
-      </listitem>
-      <listitem>
-	<simpara><ulink url="http://wiki.gnuarch.org/";>Arch</ulink>
-	archives</simpara>
-      </listitem>
-      <listitem>
-	<simpara><ulink url="http://www.bazaar-vcs.org/";>Bazaar</ulink>
-	branches</simpara>
-      </listitem>
-      <listitem>
-	<simpara><ulink url="http://darcs.net/";>Darcs</ulink>
-	repositories</simpara>
-      </listitem>
-      <listitem>
-	<simpara><ulink url="http://git.or.cz/";>Git</ulink>
-	repositories</simpara>
-      </listitem>
-      <listitem>
-	<simpara><ulink url="http://www.selenic.com/mercurial/";>Mercurial</ulink>
-	repositories</simpara>
-      </listitem>
-      <listitem>
-	<simpara>Tar archives hosted on web or ftp sites.</simpara>
-      </listitem>
-    </itemizedlist>
+    including
+    <ulink url="http://www.cvshome.org/";>CVS</ulink>,
+    <ulink url="http://subversion.tigris.org/";>Subversion</ulink>
+    <ulink url="http://wiki.gnuarch.org/";>Arch</ulink>,
+    <ulink url="http://www.bazaar-vcs.org/";>Bazaar</ulink>,
+    <ulink url="http://darcs.net/";>Darcs</ulink>,
+    <ulink url="http://git.or.cz/";>Git</ulink> and
+    <ulink url="http://www.selenic.com/mercurial/";>Mercurial</ulink>
+    repositories, as well as Tar archives hosted on web or FTP sites;
+    and using a variety of build systems, including Autotools, CMake,
+    WAF, Python Distutils and Perl Makefiles.
+    </para>
 
     <para>JHBuild is not intended as a replacement for the
     distribution's package management system.  Instead, it makes it
@@ -134,7 +110,7 @@
 
       <para>At the moment, the only way to download JHBuild is via
       Subversion.  This can be achieved with the following commands.  They
-      should be run in the directory where jhbuild will be installed
+      should be run in the directory where JHBuild will be installed
       (for example, <filename>~/checkout/gnome2</filename>).</para>
 
       <screen><prompt>$</prompt> <userinput>svn co http://svn.gnome.org/svn/jhbuild/trunk jhbuild</userinput>
@@ -155,7 +131,7 @@
 <prompt>$</prompt></screen>
 
       <para>Alternatively, if your work environment doesn't have autotools or
-      gnome-doc-utils installed you can also build and install it that
+      gnome-doc-utils installed you can also build and install JHBuild that
       way:</para>
 
       <screen><prompt>$</prompt> <userinput>cd jhbuild</userinput>
@@ -174,13 +150,12 @@
 <prompt>$</prompt></screen>
 
       <para>This command will need to be run every time you login and
-      want to use jhbuild.  In order to permanently add
+      want to use JHBuild.  In order to permanently add
       <filename>~/bin</filename> to your <envar>PATH</envar> variable,
       run the following command:</para>
 
 <screen>
-<prompt>$</prompt> <userinput>echo PATH=$PATH:~/bin >> ~/.bashrc
-</userinput>
+<prompt>$</prompt> <userinput>echo PATH=$PATH:~/bin >> ~/.bashrc</userinput>
 <prompt>$</prompt></screen>
 
       <para>Before JHBuild can be run, it is necessary to set up a
@@ -269,7 +244,7 @@
 	    <simpara>A list of module names that to not include when
 	    deciding what to build.  One use of this variable is to use
 	    the version of a package included with the distribution
-	    instead of building it</simpara>
+	    instead of building it.</simpara>
 	  </listitem>
 	</varlistentry>
 	<varlistentry>
@@ -329,7 +304,10 @@
       <orderedlist>
 	<listitem>
 	  <simpara>Install the required package from your distribution's
-	  repository.  The <command>sanitycheck</command> command
+	  repository.  A list of <ulink
+          url="http://live.gnome.org/JhbuildDependencies";>package names</ulink>
+          for different distributions is maintained on the GNOME wiki.
+          The <command>sanitycheck</command> command
 	  should be run again afterwards to make sure required tools
 	  are present.</simpara>
 	</listitem>
@@ -425,7 +403,7 @@
 
       <screen><prompt>$</prompt> <userinput>jhbuild run <replaceable>program</replaceable></userinput></screen>
 
-      <para>To start a shell with the environment used by jhbuild, use the
+      <para>To start a shell with the environment used by JHBuild, use the
       <command>shell</command> command:</para>
 
       <screen><prompt>$</prompt> <userinput>jhbuild shell</userinput></screen>
@@ -445,7 +423,7 @@
       <arg><replaceable>command-arguments</replaceable></arg>
     </cmdsynopsis>
 
-    <para>The global jhbuild options are:</para>
+    <para>The global JHBuild options are:</para>
 
     <variablelist>
       <varlistentry>
@@ -463,7 +441,7 @@
 	<listitem>
 	  <simpara>Use a module set other than the one listed in the
 	  configuration file.  This should be a relative path if the
-	  module set is located in the jhbuild moduleset folder, or an
+	  module set is located in the JHBuild moduleset folder, or an
 	  absolute path if it is located elsewhere.</simpara>
 	</listitem>
       </varlistentry>
@@ -667,7 +645,7 @@
 	  <term><option>-N</option>, <option>--no-poison</option></term>
 	  <listitem>
 	    <simpara>If one or more of a module's dependencies failed,
-	    this option forces jhbuild to try to build the module
+	    this option forces JHBuild to try to build the module
 	    anyway.</simpara>
 	  </listitem>
 	</varlistentry>
@@ -711,7 +689,7 @@
 
       <para>The <command>checkbranches</command> checks the modules in
       GNOME Subversion have the correct branch definition.  For example,
-      if modules are marked as not having branched, jhbuild checks
+      if modules are marked as not having branched, JHBuild checks
       this is true.</para>
 
       <cmdsynopsis>
@@ -727,6 +705,11 @@
 	</listitem>
 	</varlistentry>
       </variablelist>
+
+      <screen><prompt>$</prompt> <userinput>jhbuild -m gnome-2.20 checkbranches</userinput>
+libgnomecanvas is missing branch definition for gnome-2-20
+<prompt>$</prompt></screen>
+
     </section>
 
     <section id="command-reference-dot">
@@ -765,7 +748,7 @@
       <screen><prompt>$</prompt> <userinput>jhbuild dot <replaceable>modules</replaceable> | dot -Tpng > dependencies.png</userinput></screen>
 
       <figure id="sample-dot-output">
-        <title>Sample jhbuild dot output</title>
+        <title>Sample JHBuild dot output</title>
         <screenshot>
           <mediaobject>
             <imageobject>
@@ -781,7 +764,7 @@
       <title>gui</title>
 
       <para>The <command>gui</command> command starts a graphical
-      interface to jhbuild which can be used to select modules to
+      interface to JHBuild which can be used to select modules to
       build and change some options.</para>
 
       <cmdsynopsis>