STATUS revision 4d87e97bc8ad3eac376c825dbe4bc536661fc89b
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon RossApache HTTP Server 2.1 Documentation Status File.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon RossLast modified: $Date: 2003/06/28 22:55:53 $
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon RossFor more information on how to contribute to the Apache Documentation
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon RossProject, please see http://httpd.apache.org/docs-project/
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross ------------------------------
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon RossDecisions pending
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross=================
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon RossThings That Need Fixing
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross=======================
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- Windows platform docs are in desperate need of rewrites/updates for 2.0.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - Bill Rowe and Bill Stoddard are good contacts for tech questions.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - "using apache" has been done, "compiling apache" is still open
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - hints on uninstalling apache (exit monitor, close directories,
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross registry entries etc) (PR 10154)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - FAQ! UTF-8 config and URL encoding for non-ascii characters.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- New Auth system
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - Much clean-up and enhancement of aaa howto
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - Independent note on how to upgrade to new auth system
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- modules docs
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - mod_suexec: very little documentation
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - mod_proxy: updates for 2.0
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - mod_status: updates for 2.0
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - mod_example: updates for 2.0
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - mod_rewrite: explain, when what variables are actually available
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- MPM documentation
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - explain what the following command line options do
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross (perhaps in the developer/debugging docs):
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross -D ONE_PROCESS
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross one-process-mode == no threads, i.e. only one
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross process handling the requests in a single loop?
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross -D NO_DETACH (not in every MPM avail.)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross no daemon, but detached from terminal?
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross -D FOREGROUND (not in every MPM avail.)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- Individual docs will need some cleanup.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - misc/custom_errordocs.html needs to be updated to
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross essentially describe how the international error
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross docs included in 2.0 work
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - misc/perf-tuning.html - needs major rewrite for 2.0
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - platform/ebcdic.xml - needs major rework for 2.0
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- New build process.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - install.html has had a first-pass rewrite, it is basically
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross accurate, but very incomplete: many configure options are missing,
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross especially those inherited from apr.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- API documentation
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - Ben Laurie has written some hooks documentation
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - authn provider API documentation could be useful
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- Several features in Apache require write-access to the filesystem.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross Examples: CacheRoot, DavLockDB, ScriptLog
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross We should treat the things consistently in the docs, and perhaps
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross suggest the use of directory like /usr/local/apache2/var/ that is
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross httpd-writable.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross- SSL docs are generally good, but they need a refreshing by someone
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross familiar with mod_ssl and openssl.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon RossDocumentation improvements
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross==========================
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Enhancements to the DTD/XSL:
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - <glossary> tag that links to the glossary and uses some special
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross style in the css.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - New index: directives by context, including listing which directives
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross are available for each AllowOverride setting.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - New index: backout modules by type (aaa, mappers, loggers etc.)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross probably by introducing a <category> element in modulesynopsis
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - Use a tag like <var> in place of <em> for things like the
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross <syntax> listing.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - in progress
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - add letter links to glossary and quickreference,
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross perhaps also a term overview (sidebar)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - remove <pre> elements. Use <br /> and <indent> elements to get
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross a similar effect.
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Autogeneration of PDF
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Improving the documentation of the documentations' build system
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross itself (requirements, procedures)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Improving the "security docs"
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - More content and better organisation
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - mod_dav ressources are owned by the httpd
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* General cleaning and improving of module docs
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Making the directive definitions "less terse" (i.e., adding more
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross examples and details to the definitions of the directives)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Making site-specific enhancements easier, including a documented
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross and robust way for 3P module docco to be added -- and have it
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross survive a server docco upgrade
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross - This could be something a simple and hackish as a manual/extra/
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross directory (a la the 1.3 src/modules/extra/ directory) and a
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross script in the support directory that scans the files there and
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross updates the manual indices. (We do something like that now for
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross httpd.conf file with apxs [LoadModule, etc.].)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Summarize all the implemented drafts/standards with short explanations
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross within a document. (PR 16938)
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross* Provide example solutions for the mapping of encodings, especially
b819cea2f73f98c5662230cc9affc8cc84f77fcfGordon Ross for .gz etc. (also in regard to our default configuration)