[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Gnash-commit] gnash ChangeLog doc/C/usermanual/installation.x...
From: |
Ann Barcomb |
Subject: |
[Gnash-commit] gnash ChangeLog doc/C/usermanual/installation.x... |
Date: |
Sun, 27 May 2007 09:00:29 +0000 |
CVSROOT: /sources/gnash
Module name: gnash
Changes by: Ann Barcomb <ann> 07/05/27 09:00:29
Modified files:
. : ChangeLog
doc/C/usermanual: installation.xml
Added files:
doc/C/usermanual/installation: building.xml
Log message:
Started a section on building Gnash.
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/gnash/ChangeLog?cvsroot=gnash&r1=1.3368&r2=1.3369
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation.xml?cvsroot=gnash&r1=1.1&r2=1.2
http://cvs.savannah.gnu.org/viewcvs/gnash/doc/C/usermanual/installation/building.xml?cvsroot=gnash&rev=1.1
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/gnash/gnash/ChangeLog,v
retrieving revision 1.3368
retrieving revision 1.3369
diff -u -b -r1.3368 -r1.3369
--- ChangeLog 26 May 2007 20:25:12 -0000 1.3368
+++ ChangeLog 27 May 2007 09:00:28 -0000 1.3369
@@ -1,3 +1,9 @@
+2007-05-27 Ann Barcomb <address@hidden>
+
+ * doc/C/usermanual/installation.xml,
+ doc/C/usermanual/installation/building.xml: Started a section on
+ building Gnash.
+
2007-05-26 Tomas Groth Christensen <address@hidden>
* server/asobj/NetStreamGst.cpp: Don't allow play url to be changed,
Index: doc/C/usermanual/installation.xml
===================================================================
RCS file: /sources/gnash/gnash/doc/C/usermanual/installation.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -b -r1.1 -r1.2
--- doc/C/usermanual/installation.xml 22 May 2007 13:48:08 -0000 1.1
+++ doc/C/usermanual/installation.xml 27 May 2007 09:00:29 -0000 1.2
@@ -32,14 +32,13 @@
</sect3>
<sect3 id="building">
- <title>Building from Source</title>
+ &building;
</sect3>
<sect3 id="install">
- <title>Installation</title>
+ &install;
</sect3>
+
</sect2>
</sect1>
-
-
Index: doc/C/usermanual/installation/building.xml
===================================================================
RCS file: doc/C/usermanual/installation/building.xml
diff -N doc/C/usermanual/installation/building.xml
--- /dev/null 1 Jan 1970 00:00:00 -0000
+++ doc/C/usermanual/installation/building.xml 27 May 2007 09:00:29 -0000
1.1
@@ -0,0 +1,70 @@
+<title>Building from Source</title>
+
+<para>
+ Once you have <link linkend="configure">configured</link> &app;,
+ you are ready to build the code. &app; is built using
+ <emphasis>GNU make</emphasis>.
+</para>
+
+<sect3 id="compile">
+ <title>Compiling the Code</title>
+
+ <para>
+ The most basic way to compile code is simply:
+ <programlisting>
+ make
+ </programlisting>
+ If the compilation ends with an error, check the output of
+ <emphasis>configure</emphasis> and ensure that you are not missing
+ any required prerequisites.
+ </para>
+
+ <para>
+ The variables used by <emphasis>make</emphasis> can be redefined when
+ the program is invoked, if you desire it. The most interesting flags
+ are <emphasis>CFLAGS</emphasis> and <emphasis>CXXFLAGS</emphasis>,
+ which are often used to enable debugging or turn of optimization.
+ The default value for both of these variables is
+ <emphasis>-O2 -g</emphasis>. A list of influential
+ environment variables can be seen in the configuration help:
+ <programlisting>
+ ./configure --help
+ </programlisting>
+ In the following example, debugging is enabled and optimization is
+ disabled:
+ <programlisting>
+ make CFLAGS=-g CXXFLAGS=-g
+ </programlisting>
+ </para>
+</sect3>
+
+<sect3 id="processdoc">
+ <title>Creating the Documentation</title>
+
+ <para>
+ By default, documentation isn't built, even when you
+ <link linkend="install">install</link> &app;. This is because
+ there are a number of <link linkend="docdepend">dependencies
+ for the documentation</link>. Documentation is built when it
+ is specified with a specific target in the generated
+ <emphasis>Makefile</emphasis> in the <filename>doc/C</filename>
+ sub-directory. If you type <emphasis>make install</emphasis> in
+ this directory, all documents will be built.
+ </para>
+
+ <para>
+ You need to specify a target output format when you wish to create
+ documentation. The available output formats are:
<emphasis>html</emphasis>,
+ <emphasis>pdf</emphasis>, <emphasis>info</emphasis>,
+ <emphasis>man</emphasis>, and <emphasis>alldocs</emphasis>.
+ <emphasis>alldocs</emphasis> will build all of the other four output
+ formats. For example, to create HTML output, type:
+ <programlisting>
+ make html
+ </programlisting>
+ </para>
+
+ <para>TODO</para>
+</sect3>
+
+
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Gnash-commit] gnash ChangeLog doc/C/usermanual/installation.x...,
Ann Barcomb <=