-Apache HTTP Server Trunk Documentation Status File.
-Last modified: $Date$
+Apache HTTP Server Trunk Documentation Status File. Last modified: $Date$
For more information on how to contribute to the Apache Documentation
Project, please see http://httpd.apache.org/docs-project/ and
To Do List
=======================
-- Rewriting the custom-error document, which is grossly outdated.
-
-- Adding to the discussion of conditional logging, which I think
- could be turned into more of a howto than the one paragraph it's
- got now.
-
-- Refer to this product as either 'Apache HTTP Server' or 'httpd', as
- appropriate in context, rather than just 'Apache'. 'Apache' is the
- Apache Software Foundation.
-
-- Remove mentions of the 1.2 and 1.3 versions of the server.
-
- Update the http://httpd.apache.org/docs-project/docsformat.html
document to be useful. In particular:
- Document the various macros that can be used in documents.
- Improving the documentation of the documentations' build system
itself (requirements, procedures)
-- Update this document. Determine which of these issues are in fact
- still open, and which have already been dealt with.
-
-- Identify which documents are grossly out of date, and fix.
-
-- The FAQ never amounted to much. Review the current FAQ, which is
- 1.3-era, and bring it into this century.
+- Continue to enhance the FAQ, which is in the wiki:
+ http://wiki.apache.org/httpd/FAQ
- Security docs are unhelpful, and assume that the reader knows nothing.
Need something a little more advanced, which either discusses
two-httpd dav setup covered in Rich Bowen's DAV Apachecon
presentation.
-- Performance doc is way too low-level. Several people have said that
- they might help out here, but it's a significant undertaking, and more
- than a little daunting.
-
+- Performance doc "drop-in replace" wikified by Igor from Sander's
+ presentation: http://wiki.apache.org/httpd/PerformanceScalingUp
+ as well as: http://wiki.apache.org/httpd/PerformanceScalingOut
+ They both need review and updates to reflect the current state
+ of the art.
+
- Windows platform docs are in desperate need of rewrites/updates for 2.x.
- - Bill Rowe and Bill Stoddard are good contacts for tech questions.
+ - Bill Rowe is a good contact for tech questions.
- "using apache" has been done, "compiling apache" is still open
- hints on uninstalling apache (exit monitor, close directories,
registry entries etc) (PR 10154)
- FAQ: UTF-8 config and URL encoding for non-ascii characters.
- New Auth system
- - Much clean-up and enhancement of aaa howto
+ - Much clean-up and enhancement of aaa howto (Can someone clarify
+ exactly what needs cleaned up and enhanced?)
- Independent note on how to upgrade to new auth system
- Discussion of DBD auth, and, in particular, examples of how to set
up auth using each of the supported databases.
+- Expression syntax for <If>, Require expr, SetEnvIfExpr, CustomLog, ...
+ Start is in expr.xml, igalic is working on this
+
- modules docs
- the follwing modules added since 2.2 lack documentation
- - mod_dialup
- - mod_lua
- - mod_ratelimit
- mod_serf
- mod_watchdog
- mod_heartbeat
- mod_heartmonitor
- - mod_lbmethod_bybusyness
- - mod_lbmethod_byrequests
- - mod_lbmethod_bytraffic
- mod_lbmethod_heartbeat
- mod_socache_dbm
- mod_socache_memcache
the list may be incomplete
maybe some of the modules will not be included in 2.4
- mod_suexec: very little documentation
- - mod_rewrite: explain, when which variables are actually available
- (PR 16402)
-
+
+- mod_substitute and reverse proxies: Add example using mod_filter
+ (see: http://marc.info/?l=apache-httpd-users&m=128830729603423&w=2)
+
- MPM documentation
- explain what the following command line options do
(perhaps in the developer/debugging docs):
-D DEBUG
- -D ONE_PROCESS
+ -D ONE_PROCESS -- is this the same as -X, if not, should it be?
one-process-mode == no threads, i.e. only one
process handling the requests in a single loop?
-- Individual docs will need some cleanup.
- - misc/rewriteguide.html - needs cleaning in 1.3 and 2.0
+- Identify which documents are grossly out of date, and fix.
- platform/ebcdic.xml - needs major rework for 2.0
- - dso.xml - Reads as though this is a nifty new thing we just came
- up with recently.
+ - SSL docs need serious update and enhancement
+ - compat docs are wrong
+ - A basic how to has been started here:
+ http://wiki.apache.org/httpd/SettingUpModSSL
+ but it needs some work...
+ - http://blag.esotericsystems.at/2011/01/answering-trivial-and-interesting-questions-with-openssl/
+ looks like a good starting point for overhauling the FAQ, and
+ has been placed at our disposal by the author.
- API documentation
- Ben Laurie has written some hooks documentation
- authn provider API documentation could be useful
-- SSL docs need serious update and enhancement
- - compat docs are wrong
- - no basic how to setup ssl doc
- mads said he was working on this, but...
-
- How does <Proxy> fit into sections.html?
- Missing documentation for the support program checkgid
are available for each AllowOverride setting.
- New index: backout modules by type (aaa, mappers, loggers etc.)
probably by introducing a <category> element in modulesynopsis
- - Use a tag like <var> in place of <em> for things like the
+ - Use a tag like <var> in place of <em> for things like the
<syntax> listing.
- in progress
- - add letter links to glossary and quickreference,
+ - add letter links to glossary and quickreference,
perhaps also a term overview (sidebar)
- - remove <pre> elements. Use <br /> and <indent> elements to get
- a similar effect.
- Provide example solutions for the mapping of encodings, especially
for .gz etc. (also in regard to our default configuration)
- How-To style documents for more of the daily tasks
- - Logging and log reporting
- - ?
+ - Logging, log rotation, and log reporting
+ - Secure mod_dav configuration
- Writing modules - Can we provide a basic intro to writing modules,
perhaps based around mod_example, or one of the other simple example
- http://httpd.apache.org/docs/trunk/developer/ is a graveyard, and a
profound embarrassment.
- Purge all the dead links
- - API docs are generated via 'make dox'. Find somewhere that we can
- do this on a schedule, and link to that from the documentation.
- Introductory module authoring doc
- Verify links to external resources at least every year
http://httpd.apache.org/docs-project/translations.html Some of those
are accurate, and others are way outdated.
-- Rewriting the 'custom error' doc, which is ancient and doesn't flow
- very well.
-
- I'd like to expand the discussion of conditional logging, and add a
few more useful exmaples.
-
-- The mod_usertrack docs should describe what the module does, now,
- rather than spending so much time comparing it to what a long-gone
- module, which our readers never used, used to do. Examples would be
- helpful. Additionally, a significant part of the doc consists of a
- quoted email message. This seems somewhat unprofessional.
-
-- Document mod_lua based on the various docs at
- https://svn.apache.org/repos/asf/httpd/httpd/trunk/modules/lua/docs/
+ That would be a good place to document logging of cache hit/miss:
+ https://issues.apache.org/bugzilla/show_bug.cgi?id=48241#c2
+
+- Is it worth having a doc that discusses recommended (what does this
+ mean?) third-party modules like mod_security, mod_php, and so on - the
+ things that we all assume everyone uses, but some folks might not know
+ about.
+
+- Clarify which directives only affect requests when they're handled
+ by the default handler. (e.g. ForceType, TraceEnable, etc.)
+
+- Add examples using expr to mod_rewrite recipes. Possibly benchmark the
+ different approaches and make intelligent remarks about the
+ comparative value of each.
+
+- Fix this error message:
+ Request exceeded the limit of 10 internal redirects due to probable
+ configuration error. Use 'LimitInternalRecursion' to increase the limit
+ if necessary. Use 'LogLevel debug' to get a backtrace.
+ This error message is often returned when a RewriteRUle loops, in
+ which case setting LimitInternalRecursion won't do anything towards
+ fixing the problem. However, the error message is already very long.
+ Thoughts?
LaTeX Todo list
==================
- Translations.
+
projects / apache / blobdiff