X-Git-Url: https://granicus.if.org/sourcecode?a=blobdiff_plain;f=docs%2FSTATUS;h=c2446f69a163a397b7d379ac1ac79af07a507df5;hb=96746b9253f64ebc4df91522eb59d5cc111dae84;hp=47490bcada716b72a1680f5bc50babff88271d58;hpb=01ef3d0b44cb3f3f85ccb22e66c161976e913921;p=apache diff --git a/docs/STATUS b/docs/STATUS index 47490bcada..c2446f69a1 100644 --- a/docs/STATUS +++ b/docs/STATUS @@ -1,5 +1,4 @@ -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 @@ -7,41 +6,9 @@ http://httpd.apache.org/docs-project/docsformat.html ------------------------------ -ApacheCon 2010 Hackathon To Do List -=================================== - -- mod_lua documentation with examples. (PQuerna has tentatively agreed - to give us an informal session on mod_lua in order to flesh out the - docs and put some force behind the notion that mod_lua can replace - mod_rewrite - -- FAQ - Decide what to do with the FAQ - both the 1.3 FAQ and the - current FAQ, if in fact we still need one. - -- Scour the httpd.apache.org website for stale, inaccurate, or - misleading information which seems to have accumulated over the years. - -- Make the docs-project website more useful and actually welcoming of - new contributors. - To Do List ======================= -- The dns-caveats document is largely rubbish, and needs to be - completely rewritten. Many of the points stopped being true over a - decade ago. - -- The 1.3 docs need to have links from each directive forward to the - /docs/current/ version of that directive, or a note that it's not - avaialble in this century. See core.html for examples of how this - might be done. This is a large undertaking, and involves a lot of - grunt work, but will be greatly appreciated by the folks that make it - to the wrong doc via Google. - -- 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. - - 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. @@ -51,12 +18,8 @@ To Do List - Improving the documentation of the documentations' build system itself (requirements, procedures) -- 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. (RBowen - I've copied the FAQ - into the wiki at http://wiki.apache.org/httpd/FAQ and am editing it - there. Consensus seems to be that this should be its new home.) +- 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 @@ -69,32 +32,35 @@ To Do List 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 , 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_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 @@ -102,36 +68,34 @@ To Do List - mpm_simple the list may be incomplete maybe some of the modules will not be included in 2.4 - - The following modules have new docs added since 2.2, but are - grossly lacking in details and examples. - - mod_dialup - 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 fit into sections.html? - Missing documentation for the support program checkgid @@ -144,13 +108,11 @@ To Do List are available for each AllowOverride setting. - New index: backout modules by type (aaa, mappers, loggers etc.) probably by introducing a element in modulesynopsis - - Use a tag like in place of for things like the + - Use a tag like in place of for things like the listing. - in progress - - add letter links to glossary and quickreference, + - add letter links to glossary and quickreference, perhaps also a term overview (sidebar) - - remove 
 elements. Use 
 and  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)
@@ -166,8 +128,6 @@ To Do List
 - 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
 
@@ -185,6 +145,22 @@ To Do List
   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
 ==================
 
@@ -201,3 +177,4 @@ LaTeX Todo list
 
 - Translations.
 
+