Update INSTALL/README files with references to new documents.

Added new developer todo list.

diff --git a/INSTALL b/INSTALL
index 3e76e3a34fc5683a92189b59fb91e0ae77bf00b8..aeaeb02b5a4eb39aca82fba907f5c4fdc65b2654 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -1,7 +1,12 @@
 Making and Installing the OpenLDAP Distribution
 
+**
 ** It is recommended that you read or at least skim through ALL of the
 ** instructions in this file before attempting to build the software.
+**
+** You should also check for platform specific hints.
+** These are located in doc/install/hints.
+**
 
 If you want to build binaries for more than one platform from a single
 source tree, skip ahead to the "Building LDAP For More Than One Platform"

diff --git a/README b/README
index 5858d95a551f3c1a5bcc611a55afa02ed6fd2659..1529e000edbc3eb0a305069671231217e72051c4 100644 (file)
--- a/README
+++ b/README
@@ -4,12 +4,16 @@ OpenLDAP Devel README
        and unproven bug fixes.  Many of these changes will cause
        previous working programs to fail.
 
+       Additional developer documents are available in doc/devel,
+               todo list
+               guidelines for developers
+
        Client developers seeking a stable development platform
        should use -stable.
 
-OpenLDAP 1.1 Alpha README
 
-    This is the OpenLDAP version 1.1 Alpha.
+OpenLDAP 1.1 Alpha README
+       This is the OpenLDAP version 1.1 Alpha.
 
        For a description of what this distribution contains, see the
        ANNOUNCEMENT file in this directory.  For a description of
@@ -17,9 +21,13 @@ OpenLDAP 1.1 Alpha README
        directory.  For a more detailed description of how to make an
        install the distribution, see the INSTALL file in this directory.
 
+       Additional installation information, such as per platform
+       hints can be found in the doc/install directory.
+
        For more information:
                http://www.OpenLDAP.org/
 
+
 REQUIRED SOFTWARE
        Build OpenLDAP requires the following software components:
 
@@ -30,34 +38,23 @@ REQUIRED SOFTWARE
        SLAPD:
                LDBM compatible datastore
                        (Berkeley DB, Sleepycat DB2, or GDBM)
+
        SLURPD:
                LTHREAD compatible thread package
                        (POSIX pthreads, MIT pthreads, Mach Cthreads or Sun LWP)
 
        LDAPD:
-               ISODE compatible ldap distribution
+               ISODE compatible X.500 distribution
 
-       CLIENTS/CONTRIBware:
+       CLIENTS/CONTRIB ware:
                Depends on package.  See per package README.
                
 
 MAKING AND INSTALLING THE DISTRIBUTION
+       This is a quick guide.  For details, see the INSTALL file.
 
-    You should be able to make and install the distribution with a
-    default configuration by typing the following commands:
-
-       % ./configure --help
-               This will list the available options.
-               The configure script will also use your environmental
-               variables for determining compiler/linker options.
-               These environment variables are used:
-                       CC                      C compiler      (cc, ecgs)
-                       CFLAGS          C Flags         (-ansi)
-                       CPPFLAGS        CPP Flags       (-I -D)
-                       LDFLAGS         LDFLAGS         (-L -l)
-
-       % [env settings] ./configure [options]
-               this will configure the build system
+       % ./configure
+               autoconf OpenLDAP for current platform
 
        % make depend
                this will create dependency information
@@ -80,19 +77,26 @@ MAKING AND INSTALLING THE DISTRIBUTION
 
     See the INSTALL file in this directory for more information.
 
-DOCUMENTATION
 
+DOCUMENTATION
     There are man pages for most programs in the distribution and
     routines in the various libraries.  See ldap(3) for details.
 
+       Additional documentation can be found in the doc directory.
+               doc/devel       Developer Information
+               doc/drafts      LDAP-related IETF drafts
+               doc/install     Installation and Integration
+               doc/man         Raw man(1) pages
+               doc/rfcs        LDAP-related Request for Comments
+
     There is an OpenLDAP homepage available that contains the latest
     LDAP news, releases announcements, pointers to other LDAP resources,
     etc. You can access it at this URL:
 
        http://www.OpenLDAP.org/
 
-FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
 
+FEEDBACK / PROBLEM REPORTS / DISCUSSIONS
     We would appreciate any feedback you can provide.  If you have
     problems, report them to this address:
 

diff --git a/doc/devel/todo b/doc/devel/todo
new file mode 100644 (file)
index 0000000..cac3e5b
--- /dev/null
+++ b/doc/devel/todo
@@ -0,0 +1,40 @@
+OpenLDAP To Do List
+-------------------
+
+This is a list of projects that need getting done.  They are defined
+by scale of the effort as opposed to priority.  Contribute to projects
+based upon your personal priorities.
+
+If you would like to work on any of these projects, contact the
+please coordinate with the listed individual.   If no one is
+listed, contact <project@OpenLDAP.org>.
+
+If you have a project you'd like added to the list, talk it up
+on -devel.
+
+
+Larger than life projects
+-------------------------
+LDAPv3 support <kurt@openldap.org>
+LDAP C API (draft-ietf-ldapext-ldap-c-api-xx) support <kurt@openldap.org>
+Schema Repository
+Modify -lldap to be operation-level multithreaded <kurt@openldap.org>
+
+Large projects
+--------------
+redesign slapd threading
+autoconf support <kurt@openldap.org>
+Modify -lldap to be session-level multithreaded <kurt@openldap.org>
+
+
+Medium projects
+---------------
+Modify -lldap to be reentrant/threadsafe <kurt@openldap.org>
+
+
+Small projects
+--------------
+Modify -lldap to not use non-reentrant library functions <kurt@openldap.org>
+Create ldapurl (from ldapsearch?) to support searching by URL
+Create ldappasswd to support generation of crypt, sha1, md5 passwords.
+