[Gnash-commit] gnash/doc/C sources.xml [testing-documentation-refactor]

[Ann Barcomb]

CVSROOT:        /sources/gnash
Module name:    gnash
Branch:         testing-documentation-refactor
Changes by:     Ann Barcomb <ann>       06/12/20 11:42:21

Modified files:
        doc/C          : sources.xml 

Log message:
        Because the 'Building From Source' section is very long, I have added
        in an 'Overview' which summarizes the steps which are discussed under 
this
        heading.  I don't think this is redundant, because the documentation is
        divided into logical steps, whereas this summary addresses the command
        steps--but feel free to remark if you disagree.  The text part may be
        unnecessary.
        
        This commit affects the development documentation branch.

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/sources.xml?cvsroot=gnash&only_with_tag=testing-documentation-refactor&r1=1.25.2.1&r2=1.25.2.2

Patches:
Index: sources.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/sources.xml,v
retrieving revision 1.25.2.1
retrieving revision 1.25.2.2
diff -u -b -r1.25.2.1 -r1.25.2.2
--- sources.xml 20 Dec 2006 11:10:53 -0000      1.25.2.1
+++ sources.xml 20 Dec 2006 11:42:21 -0000      1.25.2.2
@@ -1,8 +1,27 @@
 <sect1 id="build">
   <title>Building From Source</title>
   
+  <sect2 id="building_overview">
+    <title>Overview</title>
   <para>
+      The typical process of building from source will involve 
+      <link linkend="codedepend">resolving dependencies</link>,
+      <link linkend="configure">configuration</link>, 
+      <link linkend="compile">compilation</link>,
+      <link linkend="runtests">testing</link>, and
+      <link linkend="install">installation</link>.
+      A simplified overview of the process would be:
+      <programlisting>
+        ./autogen.sh
+        ./configure 
+        make
+        make check
+        make install
+      </programlisting>
+      Continue reading for detailed step-by-step instructions 
+      of the entire procedure.
   </para>
+  </sect2>
   
   <sect2 id="codedepend">
     <title>Code Dependencies</title>