You are viewing a plain text version of this content. The canonical link for it is here.
Posted to apreq-cvs@httpd.apache.org by jo...@apache.org on 2003/06/15 07:29:03 UTC

cvs commit: httpd-apreq-2 README STATUS .cvsignore

joes        2003/06/14 22:29:03

  Modified:    .        README STATUS .cvsignore
  Log:
  Using doxygen now- update STATUS, README and .cvsignore
  
  Revision  Changes    Path
  1.3       +22 -5     httpd-apreq-2/README
  
  Index: README
  ===================================================================
  RCS file: /home/cvs/httpd-apreq-2/README,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- README	21 Apr 2003 04:29:46 -0000	1.2
  +++ README	15 Jun 2003 05:29:03 -0000	1.3
  @@ -36,12 +36,25 @@
     Documentation
     -------------
   
  -  XXX
  +  The C API documentation is in the docs/ directory.  It is
  +  based on Doxygen, and can be regenerated by typing
  +
  +        % make docs
  +
  +  in the main directory.
   
     Installation
     ------------
   
  -  XXX
  +  For full details please consult the INSTALL file.  Briefly,
  +
  +            % ./configure --with-apache2-apxs=/path/to/apache2/bin/apxs
  +            % make && make test
  +  (optional)% make perl_glue
  +  (optional)% make perl_test
  +            % make install
  +  (optional)% make perl_install
  + 
   
     Licensing
     ---------
  @@ -58,14 +71,14 @@
        o Mailing Lists:
   
           user lists:
  -               C/C++ API - modules@httpd.apache.org
  +               C/C++ API - modules@apache.org
                   Perl API - modperl@perl.apache.org
                    Tcl API - XXX
                   Java API - XXX
                 Python API - XXX
   
           developer list (bugs, patches, etc.):
  -                apreq-dev@cvs.apache.org
  +                apreq-dev@httpd.apache.org
   
   
     Acknowledgments
  @@ -76,4 +89,8 @@
   
     libapreq relies heavily on the use of GNU autoconf, automake and 
     libtool to provide a build environment.  The core unit tests for 
  -  libapreq are based upon CuTest.
  +  libapreq are based upon CuTest.  The environment and perl glue
  +  tests are based on Apache::Test.  
  +
  +  Doxygen generates the documentation for libapreq-2. The perl glue
  +  and pods are generated by ExtUtils::XSBuilder.
  
  
  
  1.11      +2 -4      httpd-apreq-2/STATUS
  
  Index: STATUS
  ===================================================================
  RCS file: /home/cvs/httpd-apreq-2/STATUS,v
  retrieving revision 1.10
  retrieving revision 1.11
  diff -u -r1.10 -r1.11
  --- STATUS	13 Jun 2003 01:01:36 -0000	1.10
  +++ STATUS	15 Jun 2003 05:29:03 -0000	1.11
  @@ -40,9 +40,7 @@
   
       * Settle on the Perl API and start tracking CHANGES.
   
  -    * Add documentation system.
  -
  -      [joes] suggests:
  +    * Improve documentation system:
   
         - doxygen for C API (header comments).
         - perldoc for Perl glue (pod).
  
  
  
  1.3       +1 -0      httpd-apreq-2/.cvsignore
  
  Index: .cvsignore
  ===================================================================
  RCS file: /home/cvs/httpd-apreq-2/.cvsignore,v
  retrieving revision 1.2
  retrieving revision 1.3
  diff -u -r1.2 -r1.3
  --- .cvsignore	13 Jun 2003 01:17:49 -0000	1.2
  +++ .cvsignore	15 Jun 2003 05:29:03 -0000	1.3
  @@ -1,3 +1,4 @@
  +docs
   .deps
   Makefile
   Makefile.in