[blfs-book] r11050 - trunk/BOOK/general/prog

randy at higgs.linuxfromscratch.org randy at higgs.linuxfromscratch.org
Sun Mar 3 08:59:09 PST 2013


Author: randy
Date: Sun Mar  3 08:59:09 2013
New Revision: 11050

Log:
Minor cleanup and tweaks to Programming packages

Modified:
   trunk/BOOK/general/prog/dejagnu.xml
   trunk/BOOK/general/prog/expect.xml
   trunk/BOOK/general/prog/gdb.xml

Modified: trunk/BOOK/general/prog/dejagnu.xml
==============================================================================
--- trunk/BOOK/general/prog/dejagnu.xml	Sun Mar  3 08:52:35 2013	(r11049)
+++ trunk/BOOK/general/prog/dejagnu.xml	Sun Mar  3 08:59:09 2013	(r11050)
@@ -30,11 +30,13 @@
   <sect2 role="package">
     <title>Introduction to DejaGnu</title>
 
-    <para><application>DejaGnu</application> is a framework for running test
-    suites on GNU tools. It is written in <command>expect</command>, which
-    uses <application>Tcl</application> (Tool command language). It was installed
-    by LFS in the temprary /tools directory.  These instructions install it
-    permanently.</para>
+    <para>
+      <application>DejaGnu</application> is a framework for running test
+      suites on GNU tools. It is written in <command>expect</command>, which
+      uses <application>Tcl</application> (Tool command language). It was installed
+      by LFS in the temporary <filename class="directory">/tools</filename>
+      directory.  These instructions install it permanently.
+    </para>
 
     &lfs72_checked;
 
@@ -63,31 +65,57 @@
     <bridgehead renderas="sect3">DejaGnu Dependencies</bridgehead>
 
     <bridgehead renderas="sect4">Required (Run-time Only)</bridgehead>
-    <para role="required"><xref linkend="expect"/></para>
+    <para role="required">
+      <xref linkend="expect"/>
+    </para>
 
     <bridgehead renderas="sect4">Optional</bridgehead>
-    <para role="optional"><xref linkend="docbook-utils"/></para>
+    <para role="optional">
+      <xref linkend="docbook-utils"/> and
+      <ulink url="http://sourceforge.net/projects/docbook2x/">docbook2X</ulink>
+      (both looked for by the <command>configure</command> script but not used
+      in the build)
+    </para>
 
     <para condition="html" role="usernotes">User Notes:
-    <ulink url="&blfs-wiki;/dejagnu"/></para>
-
+      <ulink url="&blfs-wiki;/dejagnu"/>
+    </para>
   </sect2>
 
   <sect2 role="installation">
     <title>Installation of DejaGnu</title>
 
-    <para>Install <application>DejaGnu</application> by running the following
-    commands:</para>
-
-<screen><userinput>./configure --prefix=/usr</userinput></screen>
-
-    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
-
-<screen role="root"><userinput>make install</userinput></screen>
-
-    <para>To test the installation, issue <command>make check</command> as
-    an unprivileged user.</para>
-
+    <para>
+      Install <application>DejaGnu</application> by running the following
+      commands:
+    </para>
+
+<screen><userinput>./configure --prefix=/usr &&
+makeinfo --html --no-split -o doc/dejagnu.html doc/dejagnu.texi &&
+makeinfo --plaintext       -o doc/dejagnu.txt  doc/dejagnu.texi</userinput></screen>
+
+    <para>
+      HTML and text documentation was created in the previous step. There
+      are different ways to create additional forms of documentation, if desired.
+      If you have <xref linkend="texlive"/> installed, create PDF and Postscript
+      docs in the <filename class="directory">doc</filename> directory by issuing
+      <command>make pdf ps</command>. If you have <xref linkend="docbook-utils"/>
+      installed, create PDF and Postscript docs in the top-level directory
+      by issuing <command>make dejagnu.{pdf,ps}</command>.
+    </para>
+
+    <para>
+      To test the results, issue <command>make check</command>.
+    </para>
+
+    <para>
+      Now, as the <systemitem class="username">root</systemitem> user:
+    </para>
+
+<screen role="root"><userinput>make install &&
+install -v -m755 -d /usr/share/doc/dejagnu-&dejagnu-version; &&
+install -v -m644    doc/dejagnu.{html,txt} \
+                    /usr/share/doc/dejagnu-&dejagnu-version;</userinput></screen>
   </sect2>
 
   <sect2 role="content">
@@ -116,8 +144,10 @@
       <varlistentry id="runtest">
         <term><command>runtest</command></term>
         <listitem>
-          <para>is the <application>DejaGnu</application> test driver program. It is
-          used to control what tests to run, and variations on how to run them.</para>
+          <para>
+            is the <application>DejaGnu</application> test driver program. It is
+            used to control what tests to run, and variations on how to run them.
+          </para>
           <indexterm zone="dejagnu runtest">
             <primary sortas="b-runtest">runtest</primary>
           </indexterm>

Modified: trunk/BOOK/general/prog/expect.xml
==============================================================================
--- trunk/BOOK/general/prog/expect.xml	Sun Mar  3 08:52:35 2013	(r11049)
+++ trunk/BOOK/general/prog/expect.xml	Sun Mar  3 08:59:09 2013	(r11050)
@@ -161,7 +161,7 @@
         <seg>autoexpect, autopasswd, cryptdir, decryptdir, dislocate, expect, ftp-rfc,
         kibitz, lpunlock, mkpasswd, passmass, rftp, rlogin-cwd, timed-read, timed-run,
         unbuffer, weather, and optionally (if <application>Expect</application> was
-        linked against <application>Tk</application>), expectk, multixterm,
+        linked against <application>Tk</application>), multixterm,
         tknewsbiff, tkpasswd, xkibitz, and xpstat</seg>
         <seg>libexpect&expect-version;.so</seg>
         <seg>/usr/lib/expect&expect-version;</seg>
@@ -356,18 +356,6 @@
         </listitem>
       </varlistentry>
 
-      <varlistentry id="expectk">
-        <term><command>expectk</command></term>
-        <listitem>
-          <para>is a combination of <application>Expect</application> with
-          <application>Tk</application> and should run any <command>wish</command>
-          or <application>Expect</application> script.</para>
-          <indexterm zone="expect expectk">
-            <primary sortas="b-expectk">expectk</primary>
-          </indexterm>
-        </listitem>
-      </varlistentry>
-
       <varlistentry id="multixterm">
         <term><command>multixterm</command></term>
         <listitem>
@@ -394,7 +382,7 @@
         <term><command>tkpasswd</command></term>
         <listitem>
           <para>is a script to change passwords using
-          <command>expectk</command>.</para>
+          <command>expect</command> and <application>Tk</application>.</para>
           <indexterm zone="expect tkpasswd">
             <primary sortas="b-tkpasswd">tkpasswd</primary>
           </indexterm>

Modified: trunk/BOOK/general/prog/gdb.xml
==============================================================================
--- trunk/BOOK/general/prog/gdb.xml	Sun Mar  3 08:52:35 2013	(r11049)
+++ trunk/BOOK/general/prog/gdb.xml	Sun Mar  3 08:59:09 2013	(r11050)
@@ -12,7 +12,7 @@
   <!ENTITY gdb-time          "1.9 SBU (5.9 SBU with checks)">
 ]>
 
-<sect1 id="gdb" xreflabel="gdb-&gdb-version;">
+<sect1 id="gdb" xreflabel="GDB-&gdb-version;">
   <?dbhtml filename="gdb.html"?>
 
   <sect1info>
@@ -20,18 +20,23 @@
     <date>$Date$</date>
   </sect1info>
 
-  <title>gdb-&gdb-version;</title>
+  <title>GDB-&gdb-version;</title>
 
   <indexterm zone="gdb">
     <primary sortas="a-gdb">gdb</primary>
   </indexterm>
 
   <sect2 role="package">
-    <title>Introduction to gdb</title>
+    <title>Introduction to GDB</title>
 
-    <para><application>GDB</application>, the GNU Project debugger, allows you
-    to see what is going on `inside' another program while it executes -- or
-    what another program was doing at the moment it crashed.</para>
+    <para>
+      <application>GDB</application>, the GNU Project debugger, allows you
+      to see what is going on <quote>inside</quote> another program while it
+      executes -- or what another program was doing at the moment it crashed.
+      Note that <application>GDB</application> is most effective when tracing
+      programs and libraries that were built with debugging symbols and not
+      stripped.
+    </para>
 
     &lfs72_checked;
 
@@ -57,7 +62,7 @@
       </listitem>
     </itemizedlist>
 
-    <bridgehead renderas="sect3">gdb Dependencies</bridgehead>
+    <bridgehead renderas="sect3">GDB Dependencies</bridgehead>
 
     <bridgehead renderas="sect4">Optional</bridgehead>
     <para role="optional">
@@ -65,26 +70,34 @@
     </para>
 
     <para condition="html" role="usernotes">User Notes:
-    <ulink url="&blfs-wiki;/gdb"/></para>
+      <ulink url="&blfs-wiki;/gdb"/>
+    </para>
 
   </sect2>
 
   <sect2 role="installation">
-    <title>Installation of gdb</title>
+    <title>Installation of GDB</title>
 
-    <para>Install <application>gdb</application> by running the following
-    commands:</para>
+    <para>
+      Install <application>GDB</application> by running the following
+      commands:
+    </para>
 
 <screen><userinput>./configure --prefix=/usr &&
 make</userinput></screen>
 
-    <para>To test the results, issue: <command>make check</command>.</para>
+    <para>
+      To test the results, issue: <command>make -k check</command>.
+    </para>
 
-    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
+    <para>
+      Now, as the <systemitem class="username">root</systemitem> user:
+    </para>
 
 <screen role="root"><userinput>make -C gdb install</userinput></screen>
 
   </sect2>
+
 <!--
   <sect2 role="commands">
     <title>Command Explanations</title>
@@ -97,6 +110,7 @@
 
   </sect2>
 -->
+
   <sect2 role="content">
     <title>Contents</title>
 
@@ -106,9 +120,10 @@
       <segtitle>Installed Directories</segtitle>
 
       <seglistitem>
-        <seg>gdb, gdbserver, and gdbtui</seg>
+        <seg>gdb and gdbserver</seg>
         <seg>libinproctrace.so</seg>
-        <seg>/usr/share/gdb/{python/gdb/command,syscalls}</seg>
+        <seg>/usr/include/gdb, /usr/share/gdb, and
+        /usr/share/doc/gdb-&gdb-version;</seg>
       </seglistitem>
     </segmentedlist>
 
@@ -120,7 +135,9 @@
       <varlistentry id="gdb-prog">
         <term><command>gdb</command></term>
         <listitem>
-          <para>is the GNU Debugger.</para>
+          <para>
+            is the GNU Debugger.
+          </para>
           <indexterm zone="gdb gdb-prog">
             <primary sortas="b-gdb-prog">gdb-prog</primary>
           </indexterm>
@@ -130,34 +147,30 @@
       <varlistentry id="gdbserver">
         <term><command>gdbserver</command></term>
         <listitem>
-          <para>is a remote server for the GNU debugger (it allows programs to be
-          debugged from a different machine).</para>
+          <para>
+            is a remote server for the GNU debugger (it allows programs to be
+            debugged from a different machine).
+          </para>
           <indexterm zone="gdb gdbserver">
             <primary sortas="b-gdbserver">gdbserver</primary>
           </indexterm>
         </listitem>
       </varlistentry>
 
-      <varlistentry id="gdbtui">
-        <term><command>gdbtui</command></term>
-        <listitem>
-          <para>is a text user interface for <application>gdb</application>.</para>
-          <indexterm zone="gdb gdbtui">
-            <primary sortas="b-gdbtui">gdbtui</primary>
-          </indexterm>
-        </listitem>
-      </varlistentry>
-
-      <!-- commenting, unless anyone feels able to describe this.
       <varlistentry id="libinproctrace">
         <term><filename class='libraryfile'>libinproctrace.so</filename></term>
         <listitem>
-          <para>contains functions that .....</para>
+          <para>
+            contains functions for the in-process tracing agent. The agent
+            allows for installing fast tracepoints, listing static tracepoint
+            markers, probing static tracepoints markers, and starting trace
+            monitoring.
+          </para>
           <indexterm zone="gdb libinproctrace">
             <primary sortas="c-libinproctrace">libinproctrace.so</primary>
           </indexterm>
         </listitem>
-      </varlistentry> -->
+      </varlistentry>
 
     </variablelist>
 



More information about the blfs-book mailing list