gnue/geas INSTALL README TODO

[Reinhard Mueller]

CVSROOT:        /cvs
Module name:    gnue
Changes by:     Reinhard Mueller <address@hidden>       01/06/10 15:32:45

Modified files:
        geas           : INSTALL README TODO 

Log message:
        documentation updates

CVSWeb URLs:
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/geas/INSTALL.diff?cvsroot=OldCVS&tr1=1.4&tr2=1.5&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/geas/README.diff?cvsroot=OldCVS&tr1=1.6&tr2=1.7&r1=text&r2=text
http://savannah.gnu.org/cgi-bin/viewcvs/gnue/geas/TODO.diff?cvsroot=OldCVS&tr1=1.52&tr2=1.53&r1=text&r2=text

Patches:
Index: gnue/geas/INSTALL
diff -u gnue/geas/INSTALL:1.4 gnue/geas/INSTALL:1.5
--- gnue/geas/INSTALL:1.4       Thu Mar 29 15:10:07 2001
+++ gnue/geas/INSTALL   Sun Jun 10 15:32:45 2001
@@ -1,30 +1,10 @@
-   geas - GNU Enterprise Application Server
-
-   Copyright (C) 2001 Free Software Foundation
-
-   This program is free software; you can redistribute it and/or modify
-   it under the terms of the GNU General Public License as published by
-   the Free Software Foundation; either version 2, or (at your option)
-   any later version.
-
-   This program is distributed in the hope that it will be useful,
-   but WITHOUT ANY WARRANTY; without even the implied warranty of
-   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-   GNU General Public License for more details.
-
-   You should have received a copy of the GNU General Public License
-   along with this program; if not, write to the Free Software Foundation,
-   Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.  
-
 Contents
 ========
 
   ORBit Notes
   Requirements (known dependancies)
   Compiling
-  Installing
   Configuring
-  Running demos
   Basic Installation (generic automake instructions)
 
 
@@ -77,7 +57,7 @@
 Compiling :
 -----------
 
-in the "geas" directory, run the autogen.sh script to configure the compile
+in the "geas" directory, run the configure script to configure the compile
 process. You must select at least one database to support.
 
 ./configure --help shows all options, but these are some to take note of:
@@ -95,63 +75,12 @@
 Type "make" to compile GEAS.
 
 
-Installing:
------------
-
-Note: Currently, the defaults are to store everything in the current
-directory. These details reflect plans, once "make install" details have
-been finalised. "make install" is not required, or particularly helpful.
-
-
-Note: The directories listed here must be readable and writeable by the user
-running GEAS. the option "--with-prefix" can be used to replace "/usr/local"
-with a suitable directory in the user's home directory for experimentation.
-The file must be in the user's path.
-
-Type "make install" to copy files to appropriate locations. This includes:
-
-(assuming $prefix = /usr/local)
-
-/usr/local/bin/geas-server    : $prefix/bin
-/usr/local/etc/geas.conf      : $sysconfdir
-/usr/local/share/geas/*.gcd   : $datadir/geas
-
-(Ideally, a separate GEAS user should be created, and given appropriate
-access rights to the required directories and files.)
-
-Consult the basic installation instructions below for details on changing
-these directories.)
-
-
 Configuring:
 ------------
 
 Edit geas.conf to reflect the database you are using. This should be
 reasonably self-explanatory, and all options are commented in the default
 file.
-
-
-Running demos
--------------
-
-Run GEAS from the 'src' directory, where it was built. 
-
-Simply run the demo program, and if everything has been set up, it should
-work immediately. However, it is important to ensure that the demo programs
-are able to find the IOR file and IDL files. These work from CVS, and may
-work if you have installed GEAS.
-
-
-
-These notes will apply once details of "make install" have been decided:
-
-The python files must be modified to locate the file 'geas-server.ior'
-output by geas-server. The line in geas.conf starting with 'iorfile'
-describes where this is put. The default is $(localstatedir)/var
-(ie /usr/local/var/geas/geas-server.ior by default)
-
-(This should be done automatically in the near future.)
-
 
 
 Basic Installation
Index: gnue/geas/README
diff -u gnue/geas/README:1.6 gnue/geas/README:1.7
--- gnue/geas/README:1.6        Sun Jun 10 11:56:43 2001
+++ gnue/geas/README    Sun Jun 10 15:32:45 2001
@@ -11,6 +11,9 @@
 To install GEAS on your system, follow the procedure described in the file
 'INSTALL'.
 
+The file 'examples/python/addrbook.py' can be used to test GEAS. Please note
+that this program expects geas to be run from the source directory.
+
 GEAS is free software. See the file 'COPYING' for the terms and conditions
 for copying, distribution and modification.
 
Index: gnue/geas/TODO
diff -u gnue/geas/TODO:1.52 gnue/geas/TODO:1.53
--- gnue/geas/TODO:1.52 Sat Jun  9 17:29:17 2001
+++ gnue/geas/TODO      Sun Jun 10 15:32:45 2001
@@ -27,7 +27,7 @@
     of errors in the design database. {classdef}
 4.  improve include concept for gcd files {classdef}
 5.  fix the error where duplicate field names pass the parser {classdef}
-6.  increase encapsulation if the modules. Data structures in the modules
+6.  increase encapsulation of the modules. Data structures in the modules
     should be private. objectcache, classdef, oql and object store are tied
     together too much. {everything}
 7.  method handling should be redesigned {methods}
@@ -80,38 +80,23 @@
 bonono IDL files.)  Current: /usr/local/share/idl but it really should at
 least be in a directory called 'geas'
 
-
 examples/python/*.py should be made executable, and possibly copied to a
 useful place. even better, having a simple way to specify in
 examples/python/Makefile.am which ones should be installed would be useful.
 (test.py is of minimal use, but other examples may be useful if they can be
 run directly.)
 
-
-
 ====================================
 
-Current coding assignments:
-
 - Create a GUI configuration management utility.
   (unassigned, talk to both rhuff and andrewm to coordinate)
    
 - Object cache: need to make flushing more intelligent. Also needs to
   modify the cache's list of edited/saved objects. (unassigned)
-
-
-Immediate
-=========
-
-Fix memory leak problems. (mostly done, a few leaks probably remain
-                           somewhere though, testing not completed)
-                          appears done: extensive testing to do.
-
-(done) Change CORBA object handling to improve memory management
 
-(done) Workaround for missing Current interface in ORBit
+- Test if there are memory leaks (there should be none).
 
-objectstore module changes: (important for ease of improving data access)
+- objectstore module changes: (important for ease of improving data access)
     check doc/internals/objectstore.txt for details
     1) write and delete object functions should be removed, and the
        objectstore.c functions changed to produce an OQL query structure
@@ -125,77 +110,63 @@
        important speed increase, particularly with large data sets, where the
        current system has excessive amounts of memory being copied for no
        significant reason.
-
-
-Near future : Intended to be done in the next six months
-===========
-
-implement validate_object() in objectcache.c (done)
-
-Optional auto-reconnect for unexpected database failures (done, postgresql
-only)
-
-Improve other configuration details (nameserver or OAF for clients locating
-the server) - details need to be investigated first.
-
-Clean up object cache and SQL database systems
-
-Dynamic class loading
 
-Security (affects several modules, and may require the CORBA security
-service to be implemented, whish is not possible in ORBit until the 'Current'
-interface has been implemented in the main CVS branch.)
+- Optional auto-reconnect for unexpected database failures (done, postgresql
+  only)
 
-Basic Object Query Language (OQL) for complex queries
+- Improve other configuration details (nameserver or OAF for clients locating
+  the server) - details need to be investigated first.
 
-Clean up objectstore module: needs to handle blocking/non blocking connect
-attempts, and attempt to reconnect on demand, but have that be configurable
+- Clean up object cache and SQL database systems
 
-rewritew GCD system to allow classes to be loaded into RAM only when needed
+- Dynamic class loading
 
+- Security (affects several modules, and may require the CORBA security
+  service to be implemented, whish is not possible in ORBit until the 'Current'
+  interface has been implemented in the main CVS branch.)
 
-Further future : Other objectives for this year
-==============
+- Basic Object Query Language (OQL) for complex queries
 
-Business class method system still needs implemented properly. (current
-alternatives have trouble with configuration.)
+- Clean up objectstore module: needs to handle blocking/non blocking connect
+  attempts, and attempt to reconnect on demand, but have that be configurable
 
-System configuration needs a lot of work.
+- rewritew GCD system to allow classes to be loaded into RAM only when needed
 
-backing out of updates needs handled. (if adding a module causes problems,
-it needs to be possible to remove it, all without breaking previous working
-modules.)
+- Business class method system still needs implemented properly. (current
+  alternatives have trouble with configuration.)
 
-Implement server administration system
+- System configuration needs a lot of work.
 
-Advanced Object Query Language (OQL) for complex queries
+- backing out of updates needs handled. (if adding a module causes problems,
+  it needs to be possible to remove it, all without breaking previous working
+  modules.)
 
-Transaction support
+- Implement server administration system
 
-Migrate GEAS internal data structures to be 'business objects' managed by the
-server. (Aimed at easing the ability for connections to be moved
-transparently between servers, as code to support moving business objects
-will then be able to move GEAS data structures as well. Not all strutures
-will need to be able to be moved.)
+- Advanced Object Query Language (OQL) for complex queries
 
+- Transaction support
 
-Distant Future : planned features, possibly a year or more away
-==============
+- Migrate GEAS internal data structures to be 'business objects' managed by the
+  server. (Aimed at easing the ability for connections to be moved
+  transparently between servers, as code to support moving business objects
+  will then be able to move GEAS data structures as well. Not all strutures
+  will need to be able to be moved.)
 
-Multiple servers working together
+- Multiple servers working together
 
-Load balancing
+- Load balancing
 
-Fault tolerance
+- Fault tolerance
 
-Advanced data manager features: object/cache manager
+- Advanced data manager features: object/cache manager
 
-Use DSI (Dynamic Skeleton Interface) to present business objects as regular
-objects. (Useful for non forms based applications.)
+- Use DSI (Dynamic Skeleton Interface) to present business objects as regular
+  objects. (Useful for non forms based applications.)
 
-Allow dynamic server upgrades: ie, install a new version of GEAS without
-disrupting current connections to the previously installed version. Must
-be able to returmn to the previous vresion as well, should the upgrade
-cause unexpected problems. (Fault tolerance will aid this immensely.)
+- Allow dynamic server upgrades: ie, install a new version of GEAS without
+  disrupting current connections to the previously installed version. Must
+  be able to returmn to the previous vresion as well, should the upgrade
+  cause unexpected problems. (Fault tolerance will aid this immensely.)
 
-Advanced data monitor
+- Advanced data monitor