Terrel Shumway wrote:
> On Wed, 2002-04-24 at 16:14, Geoffrey Talvola wrote:
> > I finally got around to adding the hopefully
> self-explanatory setting
> > MaxValueLengthInExceptionReport which defaults to 500. You
> can set it to
> > None if you want the old behavior of no limit on the length
> of values.
>
> Yes, this setting is self-explanatory (if you have followed the
> discussion that spawned it), but (I assume) there are only
> two ways you
> can learn about its existence: 1) reading this message, or 2) reading
> the source.
I added the setting to the release note file for 0.8 and to the WebKit
user's guide. What more could you possibly want?
> I poked about the user guide and found a very short list of
> settings. I
> poked about the source and found 82 settings.
I count 54 settings in WebKit. Here are the only ones I could find that are
undocumented:
ConsoleHangingIndent
ConsoleWidth (although it is described in OneShotAdapter.config
itself)
Debug (used for debugging WebKit itself -- does this really need to
be documented?)
MaxServerThreads
MinServerThreads
NTServiceLogFilename
NumRetries
SecondsBetweenRetries
StartServerThreads
UseCascadingExtensions is documented as "UseExtensionCascading" which is a
typo.
There are probably more undocumented settings in other parts of Webware
besides WebKit.
> (I added a ListOfAvailableSettings topic to the WebwareRecipes page
> http://webware.colorstudy.net/twiki/bin/view/Webware/ListOfAva
> ilableSettings )
>
> It would be nice to have a convention for documenting settings.
>
> desirable features (in order of importance)
> 1 easy to maintain (e.g. simple, located near the code that
> implements/uses it)
> 2 easy to find (e.g. by a doc-generating script)
> 3 formal enough for an admin tool to pick up and use.
>
> comments please.
Already partially done. Look at WebKit/Docs/Application.configlist and
WebKit/Docs/AppServer.configlist. These files are used to auto-generate the
documentation sections of the user's guide using
WebKit/DocSupport/config.py. It's not fully automated though -- you have to
run config.py and then cut and paste from the resulting file into the user's
guide. Still, it only takes a minute or so.
- Geoff
_______________________________________________
Webware-discuss mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/webware-discuss
