[libgda/LIBGDA_4.0] Documentation improvements
- From: Vivien Malerba <vivien src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgda/LIBGDA_4.0] Documentation improvements
- Date: Tue, 11 May 2010 19:04:43 +0000 (UTC)
commit b84c3ae62a7d9c0a3bd9c5b69ba7eb3ce6125ac9
Author: Vivien Malerba <malerba gnome-db org>
Date: Sun May 9 21:16:22 2010 +0200
Documentation improvements
doc/C/GdaStatement.dia | Bin 0 -> 4131 bytes
doc/C/GdaStatement.png | Bin 0 -> 74010 bytes
doc/C/Makefile.am | 2 +-
doc/C/libgda-4.0-docs.sgml | 18 +++++++++++-
doc/C/packaging.xml | 64 ++++++++++++++++++++++++++++++++++---------
5 files changed, 67 insertions(+), 17 deletions(-)
---
diff --git a/doc/C/GdaStatement.dia b/doc/C/GdaStatement.dia
new file mode 100644
index 0000000..b0c5014
Binary files /dev/null and b/doc/C/GdaStatement.dia differ
diff --git a/doc/C/GdaStatement.png b/doc/C/GdaStatement.png
new file mode 100644
index 0000000..8ccdf99
Binary files /dev/null and b/doc/C/GdaStatement.png differ
diff --git a/doc/C/Makefile.am b/doc/C/Makefile.am
index e52f710..387bf0e 100644
--- a/doc/C/Makefile.am
+++ b/doc/C/Makefile.am
@@ -53,7 +53,7 @@ HTML_IMAGES = DataModels.png \
writable_data_model.png GdaDataModelIter.png \
data_validation_holder.png data_validation_proxy.png data_validation_set.png \
data_proxy1.png data_proxy2.png data_proxy3.png data_proxy4.png data_proxy5.png \
- gda-sql-graph.png howto-exec.png \
+ gda-sql-graph.png howto-exec.png GdaStatement.png \
parser_gen.png parser_prov.png \
SqlIdentifiers.png
diff --git a/doc/C/libgda-4.0-docs.sgml b/doc/C/libgda-4.0-docs.sgml
index c763fee..b5d3aa0 100644
--- a/doc/C/libgda-4.0-docs.sgml
+++ b/doc/C/libgda-4.0-docs.sgml
@@ -194,9 +194,9 @@
</contrib>
</author>
</authorgroup>
- <date>January 2009</date>
+ <date>April 2010</date>
<copyright>
- <year>1999 - 2009</year>
+ <year>1999 - 2010</year>
<holder>The GNOME Foundation</holder>
</copyright>
<abstract>
@@ -588,6 +588,19 @@
API will be added in the future.
</para></listitem>
</itemizedlist>
+
+ <para>
+ The following schema illustrates how a statement is created and executed:
+ <mediaobject>
+ <imageobject role="html">
+ <imagedata fileref="GdaStatement.png" format="PNG"/>
+ </imageobject>
+ <textobject>
+ <phrase>Statement execution illustrated</phrase>
+ </textobject>
+ </mediaobject>
+ </para>
+
</para>
<para>
As each database implements its own SQL variant (all variants more or less close to the SQL92 or SQL99 standards), the
@@ -1299,6 +1312,7 @@ Description for type: DROP_COLUMN
</programlisting>
</para>
</chapter>
+
</part>
<part id="part_libgda-reports">
diff --git a/doc/C/packaging.xml b/doc/C/packaging.xml
index feaedd0..12e69d3 100644
--- a/doc/C/packaging.xml
+++ b/doc/C/packaging.xml
@@ -16,6 +16,10 @@
</para>
</listitem>
<listitem>
+ <para>the GObject introspection files (to be used by the GObject introspection framework)
+ </para>
+ </listitem>
+ <listitem>
<para>the tools, which require the runtime component
</para>
</listitem>
@@ -92,21 +96,52 @@
</sect1>
<sect1>
+ <title>GObject introspection</title>
+ <para>
+ If GObject introspection has been compiled, &LIBGDA;'s introspection files are:
+ <programlisting>
+|-- share
+| `-- gir-1.0
+| `-- Gda-4.0.gir
+`-- lib
+ `-- girepository-1.0
+ `-- Gda-4.0.typelib
+ </programlisting>
+ </para>
+ </sect1>
+
+ <sect1>
<title>Tools</title>
<para>
&LIBGDA;'s offers several tools, the most usefull being an SQL console which allows one to issue SQL statement
from the command line. This component has the following files:
- <programlisting>
+ </para>
+ <sect2>
+ <title>Diagnostic tools</title>
+ <para>
+ The diagnostic tools are usefull to test connections. This component has the following files:
+ <programlisting>
+.
+`-- bin
+ |-- gda-list-config -> gda-list-config-4.0
+ |-- gda-list-config-4.0
+ |-- gda-list-jdbc-providers-4.0
+ |-- gda-list-server-op -> gda-list-server-op-4.0
+ |-- gda-list-server-op-4.0
+ `-- gda-test-connection-4.0
+ </programlisting>
+ </para>
+ <para>
+ This component should be made dependent on the runtime component.
+ </para>
+ </sect2>
+ <sect2>
+ <title>SQL console</title>
+ <para>
+ <programlisting>
.
|-- bin
-| |-- gda-list-config -> gda-list-config-4.0
-| |-- gda-list-config-4.0
-| |-- gda-list-jdbc-providers-4.0
-| |-- gda-list-server-op -> gda-list-server-op-4.0
-| |-- gda-list-server-op-4.0
-| |-- gda-sql -> gda-sql-4.0
-| |-- gda-sql-4.0
-| `-- gda-test-connection-4.0
+| `-- gda-sql-4.0
`-- share
| `-- web
| |-- cnc.js
@@ -122,11 +157,12 @@
`-- man1
|-- gda-sql-4.0.1
`-- gda-sql.1 -> gda-sql-4.0.1
- </programlisting>
- </para>
- <para>
- This component should be made dependant on the runtime component.
- </para>
+ </programlisting>
+ </para>
+ <para>
+ This component should be made dependent on the runtime component.
+ </para>
+ </sect2>
</sect1>
<sect1>
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]