| Author |
Documentation upgrade for 3.3
|
|
| Jim Gallacher 2005-09-18, 5:46 pm |
| I'm putting together a list of things which we may want to work on for
3.3, one of which is documentation improvements.
Is there any technical reason that the request members are not sorted
alphabetically? The current arrangement makes me a little crazy.
Check the 3.1.4 docs to see what I mean.
http://www.modpython.org/live/curre...equest-mem.html
Jim
| |
| Jorey Bump 2005-09-18, 5:46 pm |
| Jim Gallacher wrote:
> I'm putting together a list of things which we may want to work on for
> 3.3, one of which is documentation improvements.
>
> Is there any technical reason that the request members are not sorted
> alphabetically? The current arrangement makes me a little crazy.
>
> Check the 3.1.4 docs to see what I mean.
> http://www.modpython.org/live/curre...equest-mem.html
They appear to be logically grouped. Rather than simply alphabetize the
page, perhaps it would make sense to organize them under headings.
| |
| Jim Gallacher 2005-09-18, 5:46 pm |
| Jorey Bump wrote:
> Jim Gallacher wrote:
>
>
>
> They appear to be logically grouped. Rather than simply alphabetize the
> page, perhaps it would make sense to organize them under headings.
>
I thought that might be the case, but the logic escapes me. 
I'd actually prefer both. List the methods alpabetically and have an
index grouped by headings. I don't mind doing the work if someone can
suggest the headings.
Jim
| |
| dharana 2005-09-19, 5:54 pm |
| In "http://www.modpython.org/live/mod_python-3.2.2b/doc-html/node97.html" you
can read:
The maximum number of mutexes mod_python uses for session locking can now be
specifed at compile time using configure --with-max-locks.
And what is the default value? Any recommendations about increasing this number
for high-traffic sites?
Also, there is an small typo in the same doc in the Improvements section:
Improvments to FieldStorage allow uploading of large files. Uploaded files
are now streamed to disk, not to memory.
First word has a typo.
Jim Gallacher wrote:
> I'm putting together a list of things which we may want to work on for
> 3.3, one of which is documentation improvements.
>
> Is there any technical reason that the request members are not sorted
> alphabetically? The current arrangement makes me a little crazy.
>
> Check the 3.1.4 docs to see what I mean.
> http://www.modpython.org/live/curre...equest-mem.html
>
> Jim
>
>
>
| |
| Jim Gallacher 2005-09-19, 5:54 pm |
| dharana wrote:
> In
> "http://www.modpython.org/live/mod_python-3.2.2b/doc-html/node97.html"
> you can read:
>
> The maximum number of mutexes mod_python uses for session locking
> can now be specifed at compile time using configure
> --with-max-locks.
>
>
> And what is the default value? Any recommendations about increasing this
> number for high-traffic sites?
>
Default is now set to 8. Previously it was 32, which some people felt
was too many for mod_python to grab on systems where there is maximum of
128. It's hard to make recommendations since it's never been
benchmarked. More is better I guess. ;) Any volunteers to do some
benchmarks?
> Also, there is an small typo in the same doc in the Improvements section:
>
> Improvments to FieldStorage allow uploading of large files.
> Uploaded files are now streamed to disk, not to memory.
>
>
> First word has a typo.
I'll fix it. Funny thing is I usually type it impovements. I guess it
wouldn't kill me to run a spellcheck before commiting changes. I'll try
to make this a practice in the future.
Thanks,
Jim
> Jim Gallacher wrote:
>
>
| |
| Jim Gallacher 2005-09-19, 5:54 pm |
| Jim Gallacher wrote:
> dharana wrote:
>
>
> Default is now set to 8. Previously it was 32, which some people felt
> was too many for mod_python to grab on systems where there is maximum of
> 128. It's hard to make recommendations since it's never been
> benchmarked. More is better I guess. ;) Any volunteers to do some
> benchmarks?
I just checked the docs, and this is mentioned in the configure section,
so do you really think it needs to go in the changes section as well? I
think having it in the main documentation should be enough.
http://www.modpython.org/live/mod_p...ure.html#l2h-10
Looking at that page again makes me think it's a good candidate for
reorganization as well. I'll add it to my list and I welcome any
suggestions for improvements.
Jim
| |
| dharana 2005-09-19, 5:54 pm |
|
Jim Gallacher wrote:
> Jim Gallacher wrote:
>
> I just checked the docs, and this is mentioned in the configure section,
> so do you really think it needs to go in the changes section as well? I
> think having it in the main documentation should be enough.
../configure --help
---
Optional Packages:
--with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
--without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no)
--with-apxs=PATH Path to apxs
--with-apache=DIR Path to Apache sources
--with-python=DIR Path to specific Python binary
--with-python-src=PATH Path to Python src - required to generate documenation
--with-max-locks=INTEGER Maximum number of locks
--with-flex=PATH Path to specific flex binary.
Flex Version 2.5.31 or greater is required to regenerate psp_parser.c
from psp_parse.l. A prepared psp_parser.c file is included with the
source, so you will only need flex if you make changes to psp_parser.l
See the README for more information.
---
I brought up this because when configuring 3.2.2b I saw the option
--with-max-locks and remembered some talk in python-dev but I had no way of
knowing what value was the default.
I don't think it should appear in the changes page but at least in the
../configure output. A lot of people won't read the html doc (even less because
it needs python-src).
Perhaps something like this would be ok for 3.2.2 final:
--with-max-locks=INTEGER Maximum number of locks [default=8]
So people will have at least an idea of the scale of this option.
>
> http://www.modpython.org/live/mod_p...ure.html#l2h-10
>
>
> Looking at that page again makes me think it's a good candidate for
> reorganization as well. I'll add it to my list and I welcome any
> suggestions for improvements.
>
If anyone has the time it would be perfect to have a default max_locks per
system somewhere in the doc, so if I have a server dedicated to mod_python and I
use linux I know my limit is X and if I use solaris my limit is Y, etc.
| |
| Jim Gallacher 2005-09-19, 5:54 pm |
| dharana wrote:
>
>
> Jim Gallacher wrote:
>
>
> ./configure --help
>
> ---
> Optional Packages:
> --with-PACKAGE[=ARG] use PACKAGE [ARG=yes]
> --without-PACKAGE do not use PACKAGE (same as --with-PACKAGE=no)
> --with-apxs=PATH Path to apxs
> --with-apache=DIR Path to Apache sources
> --with-python=DIR Path to specific Python binary
> --with-python-src=PATH Path to Python src - required to generate
> documenation
> --with-max-locks=INTEGER Maximum number of locks
> --with-flex=PATH Path to specific flex binary.
> Flex Version 2.5.31 or greater is required to regenerate
> psp_parser.c
> from psp_parse.l. A prepared psp_parser.c file is included with the
> source, so you will only need flex if you make changes to
> psp_parser.l
> See the README for more information.
> ---
>
> I brought up this because when configuring 3.2.2b I saw the option
> --with-max-locks and remembered some talk in python-dev but I had no way
> of knowing what value was the default.
>
> I don't think it should appear in the changes page but at least in the
> ./configure output. A lot of people won't read the html doc (even less
> because it needs python-src).
>
>
> Perhaps something like this would be ok for 3.2.2 final:
>
> --with-max-locks=INTEGER Maximum number of locks [default=8]
OK. I'll make this change and add some info to the README as well. FYI
the output of ./configure does give the number of locks used.
|
|
|
|