[jhbuild] doc: Don't recommend running bootstrap (GNOME bug 656818)



commit dc264b9f3a1eaaf41c5d977d0b056e12773cc148
Author: Craig Keogh <cskeogh adam com au>
Date:   Thu Apr 5 13:47:17 2012 +0930

    doc: Don't recommend running bootstrap (GNOME bug 656818)
    
    Actually recommend against running bootstrap.

 README              |    8 ++++++--
 doc/C/index.docbook |   51 ++++++++++++++-------------------------------------
 2 files changed, 20 insertions(+), 39 deletions(-)
---
diff --git a/README b/README
index 36faa4b..35c2dbf 100644
--- a/README
+++ b/README
@@ -48,8 +48,12 @@ and options. The common ones are:
 
 jhbuild bootstrap
 
-  The bootstrap command installs a set of build utilities required to
-  build most modules (e.g. autoconf, automake, etc).
+  The bootstrap command installs a set of build utilities. The build
+  utilities include autoconf , automake and similar utilities. The
+  recommended method to install the build utilities is via your
+  distribution's package management system. The bootstrap should only be
+  used if the build utilites are not provided by your distribution's package
+  management system, for example on Mac OS.
 
 jhbuild build [--autogen] [--clean] [--dist] [--distcheck]
   [--ignore-suggests] [--no-network] [--skip=module...]
diff --git a/doc/C/index.docbook b/doc/C/index.docbook
index c2a1151..9c91292 100644
--- a/doc/C/index.docbook
+++ b/doc/C/index.docbook
@@ -278,40 +278,13 @@
 
 <screen><prompt>$</prompt> <userinput>jhbuild sanitycheck</userinput></screen>
 
-      <para>If this command displays any messages, the errors can be fixed in
-        one of two ways:</para>
-
-      <orderedlist>
-        <listitem>
-          <simpara>Install the required package from your distribution's
-            repository. A list of
-            <ulink url="http://live.gnome.org/JhbuildDependencies";>package
-            names</ulink> for different distributions is maintained on the GNOME
-            wiki. Run the <command>sanitycheck</command> command again after
-            installing the distribution's packages to ensure the required tools
-            are present.</simpara>
-        </listitem>
-        <listitem>
-          <simpara>Run the <command>bootstrap</command> command to download,
-            build and install the build prerequisites:</simpara>
-
-<screen><prompt>$</prompt> <userinput>jhbuild bootstrap</userinput></screen>
-
-          <para>When complete, run the <command>sanitycheck</command> command
-            to verify the required tools are present.</para>
-
-          <note>
-            <para>The <command>bootstrap</command> command does not build all
-              the package dependencies required by the build tools. If your
-              distribution does not provide the required packages, they will
-              need to be built outside of the JHBuild environment.</para>
-
-            <para>The build tools dependencies include
-              <application>m4</application>, <application>perl</application> and
-              a C compiler (for example, <application>gcc</application>).</para>
-          </note>
-        </listitem>
-      </orderedlist>
+      <para>If this command displays any messages, please install the required
+        package from your distribution's repository. A list of
+        <ulink url="http://live.gnome.org/JhbuildDependencies";>package names
+        </ulink> for different distributions is maintained on the GNOME wiki.
+        Run the <command>sanitycheck</command> command again after installing
+        the distribution's packages to ensure the required tools are present.
+      </para>
     </section>
 
     <section id="getting-started-use">
@@ -743,9 +716,13 @@ jhbuildbot_password = 'password'
       <title>bootstrap</title>
 
       <para>The <command>bootstrap</command> command installs a set of build
-        utilities required to build most modules (e.g.
-        <application>autoconf</application>,
-        <application>automake</application>, etc).</para>
+        utilities. The build utilities include
+        <application>autoconf</application>, <application>automake</application>
+        and similar utilities. The recommended method to install the build
+        utilities is via your distribution's package management system. The
+        <command>bootstrap</command> should only be used if the build utilities
+        are not provided by your distribution's package management system, for
+        example on <systemitem class="osname">Mac OS</systemitem>.</para>
 
       <cmdsynopsis><command>jhbuild bootstrap</command>
       </cmdsynopsis>



[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]