gnue/geas NEWS doc/faq.txt doc/overview.txt doc...

[Reinhard Mueller]

CVSROOT:        /cvsroot/gnue
Module name:    gnue
Changes by:     Reinhard Mueller <address@hidden>       01/08/23 08:45:59

Modified files:
        geas           : NEWS 
        geas/doc       : faq.txt overview.txt 
        geas/doc/applications: debugging.txt geas.txt 
        geas/doc/internals: console.output.txt objectstore.txt 
Removed files:
        geas/doc/gcd   : gcd.txt 
        geas/doc/notes : classdefs.txt 

Log message:
        updated documentation

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/geas/NEWS.diff?tr1=1.7&tr2=1.8&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/geas/doc/faq.txt.diff?tr1=1.10&tr2=1.11&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/geas/doc/overview.txt.diff?tr1=1.2&tr2=1.3&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/geas/doc/applications/debugging.txt.diff?tr1=1.2&tr2=1.3&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/geas/doc/applications/geas.txt.diff?tr1=1.3&tr2=1.4&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/geas/doc/internals/console.output.txt.diff?tr1=1.3&tr2=1.4&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/gnue/geas/doc/internals/objectstore.txt.diff?tr1=1.4&tr2=1.5&r1=text&r2=text

Patches:
Index: gnue/geas/NEWS
diff -u gnue/geas/NEWS:1.7 gnue/geas/NEWS:1.8
--- gnue/geas/NEWS:1.7  Sun Aug 12 13:08:07 2001
+++ gnue/geas/NEWS      Thu Aug 23 08:45:59 2001
@@ -1,4 +1,4 @@
-New features/changes in version 0.1.0:  (YYYY-MM-DD)
+New features/changes in version 0.0.6:  (YYYY-MM-DD)
 
 o Use better PostgreSQL datatypes
 o New GEAS datatypes int16, int32, int64 and boolean
Index: gnue/geas/doc/applications/debugging.txt
diff -u gnue/geas/doc/applications/debugging.txt:1.2 
gnue/geas/doc/applications/debugging.txt:1.3
--- gnue/geas/doc/applications/debugging.txt:1.2        Mon Apr 30 15:05:16 2001
+++ gnue/geas/doc/applications/debugging.txt    Thu Aug 23 08:45:59 2001
@@ -52,11 +52,6 @@
 'man gdb' or 'info gdb' at the shell prompt. Type 'info info' for help
 on using the 'info' help program.)
 
-Note that gcc requires the option 'ggdb' in order to compile full debugging
-information. This is currently the default. (In the future, -ggdb should
-only be used when the --enable-debug option is used to request debugging
-information.)
-
 
 Running GEAS in gdb:
 --------------------
Index: gnue/geas/doc/applications/geas.txt
diff -u gnue/geas/doc/applications/geas.txt:1.3 
gnue/geas/doc/applications/geas.txt:1.4
--- gnue/geas/doc/applications/geas.txt:1.3     Sun Apr 22 19:40:33 2001
+++ gnue/geas/doc/applications/geas.txt Thu Aug 23 08:45:59 2001
@@ -50,7 +50,7 @@
 
 By default, GEAS reads $(SYSCONFDIR)/geas.conf (where SYSCONFDIR is set by
 the argument '--sysconfdir=DIR' when running autogen.sh/configure and
-defaults to $(PREFIX)/etc - ie /usr/local/etc/gewas.conf is the default
+defaults to $(PREFIX)/etc - ie /usr/local/etc/geas.conf is the default
 configuration file).
 
 This may be modified at run time, by using the '-c' command line option, as
Index: gnue/geas/doc/faq.txt
diff -u gnue/geas/doc/faq.txt:1.10 gnue/geas/doc/faq.txt:1.11
--- gnue/geas/doc/faq.txt:1.10  Wed Jun 27 15:28:39 2001
+++ gnue/geas/doc/faq.txt       Thu Aug 23 08:45:59 2001
@@ -77,7 +77,7 @@
 
 0.2) Version
 
-  Last modified: $Id: faq.txt,v 1.10 2001/06/27 22:28:39 treshna Exp $
+  Last modified: $Id: faq.txt,v 1.11 2001/08/23 15:45:59 reinhard Exp $
 
 
 0.3) Copyright
@@ -121,13 +121,14 @@
 provides reasonably detailed instructions.
 
     Run 'autogen.sh' (or 'configure' if autogen.sh is not present) with the
-appropriate arguments to enable/disable features. You must use --with-mysql
-and/or --with-postgresql to select a database driver.
+appropriate arguments to enable/disable features. In most cases, you will not
+need an argument at all, because GEAS automatically checks which database
+backends you have installed.
 
     This should warn you of any required libraries etc, which must be
 installed. (If you find something is missing that is not detected by the
-configure script, please email address@hidden with a description of the
-problem, including your OS and which version you are running.)
+configure script, please email address@hidden with a description
+of the problem, including your OS and which version you are running.)
 
     Type 'make' to compile the server.
 
Index: gnue/geas/doc/internals/console.output.txt
diff -u gnue/geas/doc/internals/console.output.txt:1.3 
gnue/geas/doc/internals/console.output.txt:1.4
--- gnue/geas/doc/internals/console.output.txt:1.3      Mon Feb 26 16:48:39 2001
+++ gnue/geas/doc/internals/console.output.txt  Thu Aug 23 08:45:59 2001
@@ -1,3 +1,8 @@
+********************************************************************
+* Note: We will change geas to use the debugging features of glib. *
+* Use of the functions described here is depreciated.              *
+********************************************************************
+
 Console Output
 ==============
 
Index: gnue/geas/doc/internals/objectstore.txt
diff -u gnue/geas/doc/internals/objectstore.txt:1.4 
gnue/geas/doc/internals/objectstore.txt:1.5
--- gnue/geas/doc/internals/objectstore.txt:1.4 Wed Jun 20 15:26:23 2001
+++ gnue/geas/doc/internals/objectstore.txt     Thu Aug 23 08:45:59 2001
@@ -17,113 +17,6 @@
 connection to a database.
 
 
-Implementing a driver
-=====================
-
-1) Add appropriate tests to the configure.in file in the main directory, and
-   set DB_FLAGS/DB_LIBS appropriately. Also create a USE_<databasetype>
-   define.
-
-2) In objectstore/objectstore.c, add a line: #include
-   "<databasetype>_access.h" (remembering to use #ifdef USE_<databasetype> to
-   prevent it being included if not needed.)
-
-3) In the function initialise_objectstore() (also in
-   objectstore/objectstore.c) add a call to the function
-   <databasetype>_create_database_handle() 
-
-4) Copy template.h to <databasetype>_access.h (Note: At time of writing,
-   this file is slightly out of synch. Check postgresql_access.h and
-   mysql_access.h for details.
-
-5) Edit the <databasetype>_connection and <databasetype>_handle structures
-   to store any database specific data. (The handle structure stores
-   information on how to connect to the database, and the connection
-   structure stores an active connection.)
-
-6) Rename the <databasetype>_*() functions to the appropriate name.
-
-7) Edit <databasetype>_create_database_handle() to record database specific
-   configuration, and set the appropriate function pointers.
-
-8) Implement each of these functions appropriately:
-       <databasetype>_get_connection()
-       <databasetype>_connect()
-       <databasetype>_disconnect()
-       <databasetype>_execute_query()
-       <databasetype>_delete_object()
-       <databasetype>_delete_all_objects()
-       <databasetype>_write_object()
-       <databasetype>_delete_database_handle()
-       <databasetype>_update_tables()
-
-   (for examples, see mysql_access.h and postgresql_access.h)
-
-
-8.1) <databasetype>_get_connection()
-
-Locate an available connection. Currently only one database and a single
-threaded client is supported, so this is relatively trivial. The connection
-is a structure containing information and any database API information for a
-connection. (Note: in reality, this is a generic function, and should not
-have been implemented for each database.)
-
-
-8.2) <databasetype>_connect()
-
-Establish a connection to the database server, given a pointer to a database
-connection (as obtained above.)
-
-
-8.3) <databasetype>_disconnect()
-
-Close a connection to a database server once it is no longer required.
-
-
-8.4) <databasetype>_execute_query()
-
-Perform a query, and translate the result from a database dependant form to
-a generic form. All database operations should be performed through this
-function.
-
-
-8.5) <databasetype>_delete_object()
-
-Delete a specific object, based on classname and OID. This should not have
-been implemented as a database specific function, as the specific SQL is
-generated by the OQL module.
-
-
-8.6) <databasetype>_delete_all_objects()
-
-Delete all objects matching a simplistic criteria. This should not have
-been implemented as a database specific function, as the specific SQL is
-generated by the OQL module.
-
-
-8.7) <databasetype>_write_object()
-
-Write an object from the cache to the database. This should not have
-been implemented as a database specific function, as the specific SQL is
-generated by the OQL module. (Originally, PostgreSQL required different
-handling, but the OQL module has been updated to understand this correctly.)
-
-
-8.8) <databasetype>_delete_database_handle()
-
-Cleanup the database handle. This is used once the database is no longer
-required. (ie: the GEAS server is shutting down, or all modules with data in
-that database have been unloaded - a future option.)
-
-
-8.9) <databasetype>_update_tables()
-
-Read the currently available classes and compare this to the classes: add
-appropriate tables/columns and make a note of any tables/columns that should
-be removed. This is called whenever new classes are loaded (ie: currently
-only on server startup) to ensure appropriate database tables exist.
-
-
 Query Results
 =============
 
Index: gnue/geas/doc/overview.txt
diff -u gnue/geas/doc/overview.txt:1.2 gnue/geas/doc/overview.txt:1.3
--- gnue/geas/doc/overview.txt:1.2      Wed Jun 20 15:26:23 2001
+++ gnue/geas/doc/overview.txt  Thu Aug 23 08:45:59 2001
@@ -2,8 +2,7 @@
 -------------
 
 The GNU Application Server manages business objects for enterprise business
-systems. A range of planned features will be available automatically to any
-application that uses the GEAS server.
+systems.
 
 For the user of an application, the existance of GEAS is not important -
 system administrators will have set it up so that their applications can
@@ -24,8 +23,7 @@
 HTML, RTF and LaTex documentation from source code. To create the
 documentation, download and install doxygen, then run
 'doxygen geas.doxygen.cfg' in the gnue/geas/ directory. It will create
-appropriate directories and files in the 'doc/code' directory. (Soon, this
-should be automatically done by automake, if doxygen is available.)
+appropriate directories and files in the 'doc/code' directory.
 
 
 Current features:
@@ -64,10 +62,6 @@
 administrator. The intention is to allow access to be controlled to fine
 levels of detail: even particular fields in particular objects will be able
 to be controlled individually.
-
-       Database independance : A data integrator will allow data to be
-transferred between GEAS and other systems, both as a batch mode operation,
-and on demand in real time.
 
        Transaction support : Many business operations require features
 offered by standard transaction based systems. GEAS will provide a simple