STATUS revision 3d25838a50fb782af88ea3ac4c5a3bc2b1a1159e
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncApache HTTP Server Trunk Documentation Status File.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncLast modified: $Date$
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncFor more information on how to contribute to the Apache Documentation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsyncProject, please see http://httpd.apache.org/docs-project/ and
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsynchttp://httpd.apache.org/docs-project/docsformat.html
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync ------------------------------
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync=======================
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Rewriting the custom-error document, which is grossly outdated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Adding to the discussion of conditional logging, which I think
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync could be turned into more of a howto than the one paragraph it's
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Refer to this product as either 'Apache HTTP Server' or 'httpd', as
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync appropriate in context, rather than just 'Apache'. 'Apache' is the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Apache Software Foundation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Update the http://httpd.apache.org/docs-project/docsformat.html
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync document to be useful. In particular:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Document the various macros that can be used in documents.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Document the translation process.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Generally update it to make it reflect the current reality of how
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Improving the documentation of the documentations' build system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync itself (requirements, procedures)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Update this document. Determine which of these issues are in fact
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync still open, and which have already been dealt with.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Identify which documents are grossly out of date, and fix.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- The FAQ never amounted to much. Review the current FAQ, which is
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync 1.3-era, and bring it into this century.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Security docs are unhelpful, and assume that the reader knows nothing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync Need something a little more advanced, which either discusses
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync application-level security, or links to something that does. I'm not
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync even sure what to say needs done. Can we get someone to elaborate on
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync what, exactly, needs written? Ivan Ristic has said maybe he would be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync willing to contribute.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - More content and better organisation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_dav resources are owned by the httpd. Perhaps write up the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync two-httpd dav setup covered in Rich Bowen's DAV Apachecon
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync presentation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Performance doc is way too low-level. Several people have said that
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync they might help out here, but it's a significant undertaking, and more
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync than a little daunting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Windows platform docs are in desperate need of rewrites/updates for 2.x.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Bill Rowe and Bill Stoddard are good contacts for tech questions.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - "using apache" has been done, "compiling apache" is still open
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - hints on uninstalling apache (exit monitor, close directories,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync registry entries etc) (PR 10154)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - FAQ: UTF-8 config and URL encoding for non-ascii characters.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- New Auth system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Much clean-up and enhancement of aaa howto
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Independent note on how to upgrade to new auth system
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Discussion of DBD auth, and, in particular, examples of how to set
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync up auth using each of the supported databases.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- modules docs
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - the follwing modules added since 2.2 lack documentation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_dialup
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_lua (Doc added, but still very rough.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_ratelimit
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_watchdog
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_heartbeat
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_heartmonitor
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_lbmethod_bybusyness
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_lbmethod_byrequests
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_lbmethod_bytraffic
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_lbmethod_heartbeat
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_socache_dbm
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_socache_memcache
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_socache_shmcb
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mpm_simple
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync the list may be incomplete
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync maybe some of the modules will not be included in 2.4
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_suexec: very little documentation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - mod_rewrite: explain, when which variables are actually available
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- MPM documentation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - explain what the following command line options do
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (perhaps in the developer/debugging docs):
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync -D ONE_PROCESS
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync one-process-mode == no threads, i.e. only one
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync process handling the requests in a single loop?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Individual docs will need some cleanup.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - platform/ebcdic.xml - needs major rework for 2.0
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - dso.xml - Reads as though this is a nifty new thing we just came
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync up with recently.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- API documentation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Ben Laurie has written some hooks documentation
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - authn provider API documentation could be useful
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- SSL docs need serious update and enhancement
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - compat docs are wrong
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - no basic how to setup ssl doc
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync mads said he was working on this, but...
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- How does <Proxy> fit into sections.html?
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Missing documentation for the support program checkgid
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- New user docs: Directory Handling (mod_dir/mod_autoindex/etc)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync (draft available in wiki)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Enhancements to the DTD/XSL:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - New index: directives by context, including listing which directives
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are available for each AllowOverride setting.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - New index: backout modules by type (aaa, mappers, loggers etc.)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync probably by introducing a <category> element in modulesynopsis
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Use a tag like <var> in place of <em> for things like the
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync <syntax> listing.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - in progress
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - add letter links to glossary and quickreference,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync perhaps also a term overview (sidebar)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - remove <pre> elements. Use <br /> and <indent> elements to get
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync a similar effect.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Provide example solutions for the mapping of encodings, especially
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync for .gz etc. (also in regard to our default configuration)
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- How-To style documents for more of the daily tasks
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Logging, log rotation, and log reporting
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Writing modules - Can we provide a basic intro to writing modules,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync perhaps based around mod_example, or one of the other simple example
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync profound embarrassment.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Purge all the dead links
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - API docs are generated via 'make dox'. Find somewhere that we can
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync do this on a schedule, and link to that from the documentation.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Introductory module authoring doc
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync - Verify links to external resources at least every year
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- Update the list of translations at
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync http://httpd.apache.org/docs-project/translations.html Some of those
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync are accurate, and others are way outdated.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- I'd like to expand the discussion of conditional logging, and add a
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync few more useful exmaples.
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync That would be a good place to document logging of cache hit/miss:
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync- The mod_usertrack docs should describe what the module does, now,
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync rather than spending so much time comparing it to what a long-gone
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync module, which our readers never used, used to do. Examples would be
4fd606d1f5abe38e1f42c38de1d2e895166bd0f4vboxsync helpful. Additionally, a significant part of the doc consists of a
There may be a license problem with the atbeginend.sty file, since