Fix a few markup nits, improve some index entries.

New documentation from Chris Petrilli <petrilli@amber.org>.

For spawn*(), point to the magic constants; some readers have a hard
time finding the bindings.

Milton L. Hankin reports that on Windows it is possible to have two
different values in the environ dict with the same key (although he
couldn't explain exactly how this came to be).  Since getenv() uses
the first one, Python should do too. (Some doubts about case
sensitivity, but for now this at least seems the right thing to do
regardless of platform.)

Sjoerd Mullender:

In splithost, accept empty host part in URLs.  This is required for
file URLs that can have an empty host part.  For such URLs, we should
not return the initial 2 slashes as part of the file name.

Removed entries for several modules which have been documented.

Updated comments on several remaining modules.

Documentation for dl module from Moshe.

Added entry for dl module.

Relocating file to Lib/lib-old.

Remove extraneous "contains" -- pointed out by Daniel Barclay
<danielb@digitalfocus.com>.

Added credit to Martin von Loewis for creating the module and
documentation.

Per Frank Stajano's suggestion, state explicitly that the functions
described in the sub-sections are directly available at the module
level.  He found this confusing.

Make the reference to the os module in the module synopsis (for the
table at the front of the chapter) a hyperlink.

Don't set type of application, it's taken care of elsewhere -- jvr

Made several grammatical corrections based on comments from Daniel
Barcla <danielb@digitalfocus.com>.

Also added example of what happens when a parameter is set both
positionally and by a keyword (one of Daniels suggestions related to
that paragraph).

For "Matching vs. Searching", remove comment that the section is
incomplete; I don't remember what else I thought I was going to put
in, but it looks o.k. to me know.

Added some reminders.

Move the setting for secnumdepth to the document classes; make the numbering
for the manual class go one deeper than it previously did (\subsection
entries will now be numbered); no change for howto documents.

This makes it easier to refer precisely to smaller sections using \ref.

Added some minor prose before the descriptions of the data attributes
to make it clear that these are instance attributes, not module data.

Added entry for pty module.

pty documentation from Moshe; with small edits.

Improve description of the example.

Usage nit: a bunch of "nor"s should have been a single "or".

Make reference to the copy_reg module a hyperlink.

Minor wording change in section title.

byteswap() method:  Tell *what* exception gets raised when the type
    cannot be byteswapped.

Remove unnecessary comma.

Define NotANumber as a subclass of ValueError when using class-based
exceptions.

When raising NotANumber, pass the string that failed as the exception
value.

Comment out XXX comment; this needn't appear in the formatted
versions.  XXX comments only need to be grep-able.

Add note about not being able to use this module with modules not
implemented in Python.

Moshe:  Remove extraneous "and".

Added entries for mutex and nis modules.

NIS documentation from Moshe.

Mutex documentation from Moshe.

Separate documentation of SUNAUDIODEV from sunaudiodev; this mirrors
similar constructs elsewhere (al/AL, gl/GL/DEVICE).

Fix some typos.

Add an index entry.

Add entries for the sched module.

While we're at it, convert to docstrings and set the indentation level
to 4.

Moshe's section on the sched module, with edits.

Update to Sjoerd's documentation of the chunk module, with some
additions from Moshe's version.  Used my table for describing the
chunk format, and added some markup and index entries.

Close debugger when closing.  This may break a cycle.

Break cycle on close.

Destroy the tree when closing.

Add destroy() method to recursively destroy a tree.

Extend _close() to break cycles.
Break some other cycles too (and destroy the root when done).

Add _close() method that does the actual cleanup (close() asks the
user what they want first if there's unsaved stuff, and may cancel).
It closes more than before.

Add unload_extensions() method to unload all extensions; called from
_close().  It calls an extension's close() method if it has one.

Add close() method that breaks cycles.

Add unregister() method.
Unregister everything at closing.
Don't call close() in __del__, rely on explicit call to close().

Add close() method that breaks a cycle.

Break some cycles when the widget is destroyed.

Patch from Sjoerd Mullender:

Make argument names equal to what is used in the documentation of the
file object, since chunks are supposedly file-like.

Mikael Lyngvig writes:

I just noticed that the changes below also apply to cmpcache.py, which
is virtually identical to cmp.py.

Patch by Mikael Lyngvig:

1. Fix incorrect file open mode on Win32 platforms (use "rb" instead
of "r").

2. Add shallow parameter to cmp.cmp().  If false, deep file
comparisons are made.

The module should be 100 percent backwards compatible.

Clarify the example by explicitly importing the fcntl module -- this
avoid being fooled into thinking that fcntl and FCNTL are the same
thing -- they aren't!  (fcntl is the extension, FCNTL.py is h2py
output that defines all the constants).

(XXX The example is still weird -- I think there's a more portable way
to do locking now.  That's for someone else to fix...)

Sjoerd Mullender writes:

Urllib makes the URL of the opened file available through the geturl
method of the returned object.  For local files, this consists of
file: plus the name of the file.  This results in an invalid URL if
the file name was relative.  This patch fixes this so that the
returned URL is just a relative URL in that case.  When the file name
is absolute, the URL returned is of the form file:///absolute/path.

[I guess that a URL of the form "file:foo.html" is illegal...  GvR]

Small patch by Tim Peters - it was using self.maxlist when it should
be using self.maxdict.

Simplified version of a patch by Chih-Hao Huang, who wrote:

"""
When there are additional Setup files, specified by -e option of freeze,
checkextenstions.py assumes that *.o, *.a, -Lpath, and -Rpath are all
relative to where the Setup file is. select() inserts the path to the
Setup file to make them absolute. However, the assumption is not true.
There are cases that absolute paths are specified for them. The inserted
prefix, by select(), results in error.

The following fix check for absolute paths. The assumption is: an
absolute path begins with either '/' or '$'. In the latter case, it is
from the environmental variable. (Variables defined locally in the Setup
file have already been handled by expandvars())
"""

My version of the patch has been verified by Charles Waldman (a
colleague of Chih-Hao).

Removed tty module entry.

Add entries for tty module.

Updates from Moshe, again edited by me.  Describe the parameters to
border() using a table instead of text for ease of comprehension.

Added "See Also" section for termios module.

Various updates.

tty module documentation from Moshe, with some editing and an added
"See also" section.

Added more sections...

Two more from Moshe!

Drag manager constants.

Make the mode parameter to open() default in the same way as for wave.open().

Added entry for the chunk module.

New section from Moshe Zadka, modified by FLD for markup, some
additional content.

mod from Joe Strout: when quitting, catch errors in window.close() methods and ignore them. Otherwise one can never quit.

Patch by Tim Peters:

Introduce a new builtin exception, UnboundLocalError, raised when ceval.c
tries to retrieve or delete a local name that isn't bound to a value.
Currently raises NameError, which makes this behavior a FAQ since the same
error is raised for "missing" global names too:  when the user has a global
of the same name as the unbound local, NameError makes no sense to them.
Even in the absence of shadowing, knowing whether a bogus name is local or
global is a real aid to quick understanding.

Example:

D:\src\PCbuild>type local.py
x = 42

def f():
    print x
    x = 13
    return x

f()

D:\src\PCbuild>python local.py
Traceback (innermost last):
  File "local.py", line 8, in ?
    f()
  File "local.py", line 4, in f
    print x
UnboundLocalError: x

D:\src\PCbuild>

Note that UnboundLocalError is a subclass of NameError, for compatibility
with existing class-exception code that may be trying to catch this as a
NameError.  Unfortunately, I see no way to make this wholly compatible
with -X (see comments in bltinmodule.c):  under -X, [UnboundLocalError
is an alias for NameError --GvR].

[The ceval.c patch differs slightly from the second version that Tim
submitted; I decided not to raise UnboundLocalError for DELETE_NAME,
only for DELETE_LOCAL.  DELETE_NAME is only generated at the module
level, and since at that level a NameError is raised for referencing
an undefined name, it should also be raised for deleting one.]

Patch submitted by Toby Dickenson and approved by Mark Hammond.
Toby writes:

winmakemakefile.py tries to allow for spaces in the python install
path, by adding quotes around the appropriate filenames. It doesn't
quite get this correct; sometimes the quotes end up in the middle of
the path.

Microsoft's NMAKE version 6.0 is happy with this (!!!!)  unless there
is also a space in the name. I guess most users of freeze on windows
do not use the same path as the binary distribution.

I've tested the following changes on systems with and without a space
in the path.

Added some "See also" references to htmllib docs.

Documented htmlentitydefs.

Added entry for curses module.

Added entries for four of Moshe's documentation sections.

Preliminary documentation for the curses module by Moshe Zadka, with
lots of markup fixes and some English nits fixed.

Still needs real review.  Some of the function signatures used in this
module are really bad!  (Two leading optional parameters? Ugh!)

Add warning FreeBSD users of a problem with curses and termcap,
submitted by Klaus-Juergen Wolf.

Fix a markup error.

Three more modules documented by Moshe!

Initial minimal test program: print information on anything dropped onto Python
window.

Print something on stderr in case of exceptions in callback routines.

Drag manager interface (completely untested, so far)

Greg McFarlane submitted two missing Text methods: mark_next() and
mark_previous().

Added a few minor comments, mostly to discourage documentation of
really old modules that may become obsolete.

Added paragraph about potential re-initialization of extension
modules; responding to suggestion by Robin Boerdijk
<Robin.Boerdijk@nl.origin-it.com>.

Further clarfication of the system-dependence of the system() return
value, based on comments from Tim Peters.

Relocating file to Lib/lib-old.

Re-categorize the dump module as obsolete.

fpformat has been documented for at least a week now!

CRITICAL PATCH!

We occasionally received reports from people getting "invalid tstate"
crashes (this is a fatal error in PyThreadState_Delete()).  Finally
several people were able to reproduce it reliably and Tim Peters
discovered that there is a race condition when multiple threads are
calling this function without holding the global interpreter lock (the
function may be called without holding that).

Solved the race condition by adding a lock around the mutating uses of
interp->tstate_head.  Tim and Jonathan Giddy have run tests that make
it likely that this fixes the crashes -- although Tim hasn't heard
from the person who reported the original problem.

# Darn!  Local variable l declared but not used in abstract_issubclass().

Small markup & usage adjustments.

When looking for things that might be modules, include *module.c from
the Modules/ directory.  Most of the remaining undocumented modules
seem to be living there.

Patch suggested (and partially provided) by Lars Damerow: instead of
always lowercasing the option name, call a method optionxform() which
can be overridden.  Also make the regexps SECTRE and OPTRE non-private
variables so they can also be overridden.

Correction: the parameters of new.instance() are type-checked.

Edited several of the descriptions for English usage and more
consistent style.

Updated version from Moshe, with a re-written warning about the
side-effect of cmpcache.cmp() using statcache.stat() internally.

Minor markup nits.

Small English usage nits.

Small markup and English usage nits.

In collect_children(), put a try-except around os.waitpid() because it
may raise an exception (when there are no children).  Reported by
Andy Dustman.

Add reminder that wave.open() documentation should be updated for the
next Python release.

open():  Make the mode parameter optional; if omitted or None, use the
 mode attribute of the file object (if it has one), otherwise
 use 'rb'.

 The documentation should still show this as required until
 there's a new release.