Commit Graph

2700 Commits

Author SHA1 Message Date
Fred Drake adf2dbfced Added section for filecmp. 1999-10-29 17:24:12 +00:00
Fred Drake c7b5b3c998 filecmp documentation from Moshe Zadka <moshez@math.huji.ac.il>. 1999-10-29 17:23:15 +00:00
Fred Drake 7eaf6828cb Added deprecation notes, in case anyone decides to read these anyway. 1999-10-26 16:31:51 +00:00
Fred Drake 143db4b041 cmp and cmpcache are now obsolete, so don't include their
documentation sections.
1999-10-26 16:28:04 +00:00
Fred Drake a8052a3113 Added cmp and cmpcache to the "Obsolete" section. 1999-10-26 16:27:28 +00:00
Fred Drake 714fd26a2f Documented Beep() function. 1999-10-22 21:08:56 +00:00
Fred Drake d6512808f0 Module/script to parse the reference count data file and make the
information accessible to Python.

When run as a script, just dumps the information back out in the data
format, with functions in sorted order and a blank line between
different functions.

Still need to apply the information somehow.
1999-10-20 21:50:31 +00:00
Fred Drake 805bf1b330 Added note that Skip created the initial version of this file.
Fixed up a few of his ??? comments.
1999-10-20 16:03:38 +00:00
Fred Drake 7b7dc6b49d Initial version as provided by Skip Montanaro <skip@mojam.com>. 1999-10-20 15:06:24 +00:00
Fred Drake 39d4a0237a Fixed typo in explanation of abspath(); noticed by Paul Prescod
<paul@prescod.net>.
1999-10-18 14:10:06 +00:00
Fred Drake 532998e00d "make clobber" should remove modindex.html as well.
Added realclean and distclean as synonyms for clobber.
1999-09-24 13:51:19 +00:00
Fred Drake 88c786dad9 icons/ should not be ignored here now that this is it's real home. 1999-09-24 13:48:38 +00:00
Fred Drake cf1b06ec47 Added --about option to specify the file to load "About this
document..." text from, defaulting to ../html/about.dat.
1999-09-23 16:55:09 +00:00
Fred Drake 8903be62a8 Tell mkhowto to use stdabout.dat for the documents it processes here. 1999-09-23 16:54:06 +00:00
Fred Drake b35f2b7ef8 Remove some <SPAN> elements that were used only to carry a CLASS
attribute; stick the CLASS on an existing element.

Use a variable for the name of the file to get "About this
document..." text from.
1999-09-23 16:53:09 +00:00
Fred Drake f62b352a5e Remove the "Comments and Questions" section, allowing this to be used
for non-standard Python documentation.
1999-09-23 16:48:54 +00:00
Fred Drake b9bd0b7c82 Version of about.dat that should only be used for the standard
documentation.
1999-09-23 16:48:05 +00:00
Fred Drake d37cecfda4 Remove some <SPAN> elements that were used only to carry a CLASS
attribute; stick the CLASS on an existing element.
1999-09-23 16:45:08 +00:00
Fred Drake f42d7a78fc Oops, missed this one! 1999-09-23 15:38:14 +00:00
Fred Drake d3d28d39f8 img_tag(): Tighten up the generated SRC attribute a bit; if the image
relative URL starts with "./", remove "./".
1999-09-23 15:29:45 +00:00
Fred Drake d52879ccdc do_cmd_rfc(): Simplify the generated markup. 1999-09-22 19:58:51 +00:00
Fred Drake 52ea0ce977 Added --image-type option to allow use of either GIF or PNG images.
Job.warning():  New method; use this instead of writing to sys.stderr
                directly.  Ensures warnings are also sent to the log
                file.

Job.log():  New method; write a message to the log file.  Use from
            .message() and .warning().
1999-09-22 19:55:35 +00:00
Fred Drake 191439ab6b Some updates to allow ../tools/mkhowto to add various bits to the
supplemental l2h initialization file it creates and still get all the
right behavior.  In particular, it can change the image type and icon
location and not get inconsistent results.

Some code to help suppress various navigational pages; this might be
interesting when generating HTML to create HTML Help documents, since
the navigation support creates confusing hits in the full text
search.  HTML Help also provides a lot of the navigational
infrastructure, so duplicating it makes it more tedious to use.
1999-09-22 19:50:51 +00:00
Fred Drake 3e1a98a336 PNG version of the icons, converted from the GIFs
by Michael Hudson <mwh21@cam.ac.uk>.
1999-09-22 14:38:25 +00:00
Fred Drake 0297719180 Added section about where to send comments, questions, & bug reports. 1999-09-21 15:45:06 +00:00
Fred Drake 933d5a7c6e os.name: Note that 'java' is one of the registered names. 1999-09-17 14:38:39 +00:00
Fred Drake e6fb1c4bd3 Added documentation for inet_aton() and inet_ntoa(), from Ben
Gertzfield <che@debian.org> (with minor changes).

(Should have been here instead of in the branch in the first place,
since these weren't in for the 1.5.2 release.)
1999-09-16 15:50:00 +00:00
Fred Drake 0ba58158c5 Added "import string" to a couple of examples that describe string
module functions, to clarify that the import is not automatic.
Suggested by Koray Oner <Koray.Oner@Eng.Sun.COM>.
1999-09-14 18:00:49 +00:00
Fred Drake 244ad3ca15 Name the parameter to expr() and suite() "source" instead of "string". 1999-09-09 14:16:36 +00:00
Fred Drake 8779f648d2 Added descriptions of the t#, w, and w# PyArg_ParseTuple() format
characters; these are the ones for the buffer interface.
1999-08-27 15:28:15 +00:00
Fred Drake 0ee4891c82 Update the instructions slightly.
Add a new section describing what each of the tools does, in general
terms.
1999-08-26 18:08:13 +00:00
Fred Drake 4f0279f439 Removed; no longer needed now that the other tools can handle entity
references directly.
1999-08-26 18:05:23 +00:00
Fred Drake abb158f56b feed(): Added support for ESIS '&' lines. 1999-08-26 18:04:32 +00:00
Fred Drake 1f33292542 Remove use of fixgenents.sh; no longer needed. 1999-08-26 17:57:18 +00:00
Fred Drake 3cf4eb4e3d Specify: \geq --> &geq;
\leq    --> &leq;
                \LaTeX  --> LaTeX       (just text)
                \TeX    --> TeX         (just text)
1999-08-26 17:56:47 +00:00
Fred Drake f6199edcd3 Conversion.subconvert(): Added support for "entityref" parameters
(must be named in the conversion spec.).

TableParser.start_entityref():  New method.  Use to support creating
        entity references via the conversion specification.
1999-08-26 17:54:16 +00:00
Fred Drake a20581c1e5 write_esis(): Added support for ENTITY_REFERENCE nodes. 1999-08-26 17:51:56 +00:00
Fred Drake 53eae8e81b convert(): Add support for ESIS '&' lines, and make sure we don't
silently ignore unrecognized lines.
1999-08-26 17:50:26 +00:00
Guido van Rossum e7f19200e8 Doco update from Sjoerd Mullender. 1999-08-26 15:57:44 +00:00
Fred Drake 2900ff9382 Added paragraph explaining that except clauses can't be empty; that
pass can be used if needed.  By Dan Wolfe <wolfeman@apple.com>.
1999-08-24 22:14:57 +00:00
Fred Drake 4c2533fe3c Added sentence "All exceptions must have an executable block."; from
Dan Wolfe <wolfeman@apple.com>.
1999-08-24 22:14:01 +00:00
Fred Drake b68a125d64 Added additional index entries.
Minor markup nits.
1999-08-24 20:16:29 +00:00
Fred Drake 76dd228f52 whrandom should come immediately after random, not before. 1999-08-23 20:12:11 +00:00
Fred Drake c924b8d976 Clarified start parameter to Py_CompileString, documented
Py_eval_input, Py_file_input, and Py_single_input.

Problems reported by Aaron Brancotti <aaron@icona.it>.
1999-08-23 18:57:25 +00:00
Fred Drake abf8a1daa8 rewrite_descriptor(): Fix bug that dropped the first TEXT node from
<description> elements.  Add another sanity
                       check to make sure a special case only becomes
                       involved for <opcodedesc> and <opcodedescni>
                       elements.

fixup_paras_helper():  Clean up control flow.

Everywhere that checks node.nodeType==ELEMENT and node.tagName now
just check node.nodeName (nodeName is guaranteed for all node types
and will be special values that don't conflict with GIs for
non-ELEMENT nodes).  Simplifies a number of tests and improves
readability in a lot of places.
1999-08-20 14:28:29 +00:00
Fred Drake 7eba1d8bbe Tell what the result objects are (based on comment from the list). 1999-08-19 17:00:38 +00:00
Fred Drake 9ed56de752 Added item regarding random/whrandom. 1999-08-19 15:37:35 +00:00
Guido van Rossum b3fc9d148d Added disclaimer to the sleep() function. 1999-08-19 14:42:54 +00:00
Fred Drake 31e5e37196 Explain the possible range of values for the pid parameter to
waitpid().
1999-08-13 13:36:33 +00:00
Fred Drake 68921dfa31 In note mentioning [].remove()'s exception, tell what exception is
raised.  Prompted by Barry's whining.  ;-0
1999-08-09 17:05:12 +00:00
Fred Drake d3fbdfd007 Add index entries for open():
buffer size, I/O
	I/O control, buffering
	line-buffered I/O
	unbuffered I/O
1999-08-05 13:43:08 +00:00
Fred Drake 8c9fc00f8d Add index entry "I/O control, buffering" for fdopen(). 1999-08-05 13:41:31 +00:00
Fred Drake a94f6762bc Add index entry "I/O control, buffering" for makefile(). 1999-08-05 13:41:04 +00:00
Fred Drake 58c5a2a53c Started documentation on buffer objects & types. Very preliminary.
Greg Stein:  Please help with this; it's your baby!
1999-08-04 13:13:24 +00:00
Guido van Rossum 068bdb181d Change the directory tree walking example to use clearer variable
names, some suggested by Joe Ellsworth.
1999-08-03 21:52:29 +00:00
Fred Drake 46ab6dfa89 Re-write in Python for portability. About 30% slower, but who cares?! 1999-08-03 17:54:39 +00:00
Fred Drake 82ebc27357 remap_element_names(): Only used for things that the new conversion
engine in latex2esis.py can do, so discard it.

paragraph detection & markup:  Handle some of the list-like
		environments properly, picking up paragraphs inside
		list items.  (Only changed a few element-sets used for
		recognition.)

fixup_refmodindexes_chunk():  Use the right attribute to determine the
		module a <ref*modindex/> element is referring to.

convert():  Don't call remap_element_names(); it was removed.
1999-08-03 15:32:48 +00:00
Fred Drake 2f6ec9ca81 The new conversion engine supports more of the table re-writing than
the old one, so use it.
1999-08-03 15:27:37 +00:00
Guido van Rossum 32bc45f737 Removed PyMapping_Clear() -- it was wishful thinking and serves no
great purpose.
1999-08-02 20:49:37 +00:00
Fred Drake 83c0983bf6 Use the mksourcepgk script instead of mktarball.sh. 1999-08-02 20:20:14 +00:00
Fred Drake 9ff3a6a6e7 Remove obsolete version of script. 1999-08-02 20:19:42 +00:00
Fred Drake 9f2b42080a Re-implementation of mktarball.sh as a more portable Python script;
with a more descriptive name.

Allow creation of multiple archive formats with a single pass; useful
in this case since it uses a fresh export/checkout from CVS to ensure
that the tree is "clean" (no build turds, saved files, &c).  Use --all
to create all supported formats.
1999-08-02 20:19:17 +00:00
Fred Drake 080c1b5af6 bwrite(), ewrite(): Helpers for diagnostic output; essentially the
same as sys.stderr.write(), but bwrite() will make it
		bold if stderr is a tty (for visibility).

		Use these everywhere instead of accessing
		sys.stderr.write() directly.

find_all_child_elements():  Find all elements by type name that are
		immediate children of another.

cleanup_synopses():  Receive both the document and fragment objects as
		parameters; if only the document is passed, synopsis
		information is never found since it's in the fragment!

build_para():	Add a chunk of code to ensure that a newline always
		follows the </para> end-tag.  Not really important, but
		makes presentation consistent for authoring/
		maintenance.

fixup_bifuncindexes_chunk(): Use find_all_child_elements() instead of
		find_all_elements() so we don't work with too many
		levels at once; that could cause DOM exceptions with
		the <elem>.removeChild() method.
1999-08-02 14:46:15 +00:00
Fred Drake 4fbdf9779c Mostly minor changes.
Removed some obsolete commented-out code.

Merged BaseConversion into Conversion since there's only one
conversion process now.

Remove push/pop of output stream; it's no longer needed.
1999-08-02 14:35:25 +00:00
Fred Drake d158b85896 This doesn't need to do nearly as much for the new conversion, so
simplify.
1999-08-02 14:32:46 +00:00
Fred Drake 031e222499 A few small improvements to the conversion. 1999-08-02 14:32:11 +00:00
Fred Drake c71b802c47 Markup nits.
Adjust examples to use the object interface instead of the function
interface.
1999-08-02 14:30:52 +00:00
Fred Drake ce201128b0 Fixed hyperlink references to the __builtin__ and __main__ modules;
error reported by Dale Nagata <DNagata@creo.com>.
1999-08-02 14:13:09 +00:00
Fred Drake eac8abee4e Ripped out the old conversion. 1999-07-29 22:42:27 +00:00
Fred Drake 865e9ff98e Added a few more passes through the document fragment. Not actually
very interesting.
1999-07-29 22:23:19 +00:00
Fred Drake 96e4a06fa6 Massive changes.
Separate the Conversion class into a base and a subclass; the subclass
is pretty minimal but the separation is useful for....

NewConversion:  New class that implements a somewhat different
		approach to the conversion.  This uses a table of
		instances (rather than tuples) that have more
		information than the tuples used for the older
		conversion procedure.  This allows a lot more control
		over the conversion, and it seems to be pretty
		stable.

TableEntry,
Parameter:	New classes that are used to build the conversion
		specification used by NewConversion.

TableParser:	xmllib.XMLParser subclass that builds a conversion
		specification from an XML document.

load_table():	Convenience function that loads a table from a file.

main():  Added flags --new and --old; these select which conversion is
	 used.  The default is --new.

Several fixes have been made in the old conversion as well; these were
done before writing & switching to the new conversion, and should be
archived.

The next checkin of this file will discard the old conversion; is is
kept in this checkin to allow it to be retrieved if needed, and to
avoid lossing the bugfixes that have been made to it in the interim.
1999-07-29 22:22:13 +00:00
Fred Drake 2394c98c05 Minor updates. 1999-07-29 22:14:09 +00:00
Fred Drake ada2de67b3 Use the (new) buildFragment() method of the EsisBuilder rather than
implementing it all here.
1999-07-29 22:13:31 +00:00
Fred Drake f032cdbb24 Some minor cleanup. 1999-07-29 22:03:52 +00:00
Fred Drake bc2285eb60 Conversion specification, used by a new path through latex2esis.py.
The specific markup conversion is coded here instead of an even more
cryptic table in the code of latex2esis.py.
1999-07-29 22:03:11 +00:00
Fred Drake 478a265057 Minor update. 1999-07-29 22:01:39 +00:00
Fred Drake c35367e439 Change an {\em ...} to \var{...} and a {\bf ...} to \program{...} (the
new markup makes sense in context).

These allow the SGML/XML conversion updates to work, & should not have
still been in there anyway.
1999-07-29 13:56:41 +00:00
Fred Drake 4ef3ea0cc4 Add support for bzip2 compression.
New target: distfiles, create all distribution archives, regardless of
archive format.  (Individual targets remain for each archive format.)
1999-07-27 16:30:59 +00:00
Fred Drake 5772f33b6c Add support for bzip2 using --bzip2. 1999-07-27 16:29:30 +00:00
Fred Drake b5213c3010 Ignore additional compressed formats. 1999-07-27 14:23:25 +00:00
Fred Drake 8d21243c3e Added description of optional parameter to UserDict constructor.
Omission reported by Barry Warsaw.
1999-07-26 15:45:52 +00:00
Fred Drake 7dcc69a979 Add zip archive support for html, pdf, ps, and latex archives.
"zips" target produces all possible .zip files.
1999-07-23 16:11:36 +00:00
Fred Drake 8ea15f3495 Add --zip parameter; make this able to produce .zip files as well as
.tgz files.
1999-07-23 16:09:11 +00:00
Fred Drake de5d5ce7bc Update getattr() description to document the optional third
parameter.  Thanks to Barry Warsaw for pointing out the oversight.
1999-07-22 19:21:45 +00:00
Fred Drake 06c5a8b52e Make the default target xml instead of sgml. 1999-07-22 13:57:12 +00:00
Fred Drake 7dbde51f97 Make the default target xml instead of sgml.
Use a temporary file to pass results from latex2esis.py to
docfixer.py; this makes for better error detection by make (if the
first pipeline stage fails, make wasn't catching it).
1999-07-22 13:56:51 +00:00
Fred Drake 5d48e458e4 typo: privide --> provide
Reported by Nadim Ghaznavi <nadim@ghaznavi.com>.
1999-07-20 13:21:42 +00:00
Fred Drake 860e256147 Added comment clarifying that RELEASE is the documentation release
number, not the Python release.

Removed VERSION since it is not used.
1999-07-12 16:52:50 +00:00
Fred Drake 6b3fb78ca8 do_cmd_funclineni(): New function; non-indexing form of \funcline. 1999-07-12 16:50:09 +00:00
Fred Drake 6db897c52c Move chdir() and getcwd() descriptions to "Files and Directories" with
a pointer from the "Process Parameters" section.  Based on comments
from Aahz Maruch, Tim Peters, and GvR.
1999-07-12 16:49:30 +00:00
Fred Drake f930d827bb Use the same names for CLASS attributes as elsewhere. 1999-07-12 16:28:50 +00:00
Fred Drake bb7eff96d4 Updated Milan's email address. 1999-07-12 15:26:43 +00:00
Fred Drake 3a4ceb707d Several methods return tuples, not lists. 1999-07-07 14:04:38 +00:00
Fred Drake 363d67c2e6 Move some misc. comments from the example section to the main section.
Use the lowercase versions of the method names in the example, since
that's what's documented (Greg Stein's suggestion).  Add a blank line
after the import line for clarity.
1999-07-07 13:42:56 +00:00
Fred Drake 1508970a47 dir() method description revised based on comments from Greg Stein. 1999-07-07 13:36:22 +00:00
Fred Drake 6166b871a2 Missing space; reported by Robert Kern <kernr@ncifcrf.gov>. 1999-07-06 21:00:18 +00:00
Fred Drake d5dfe984e7 Fix a number of minor problems pointed out by /F. 1999-07-06 15:50:23 +00:00
Fred Drake 0d6e6e0b39 Fixed typo reported by /F; thanks! 1999-07-06 15:43:55 +00:00
Fred Drake e72d48d5b2 Bump the release number to 1.5.2p1. 1999-07-06 14:30:04 +00:00
Fred Drake 919e74ce88 Darn! Forgot to re-target. 1999-07-02 15:27:14 +00:00