[Python-checkins] r45839 - python/trunk/Doc/lib/lib.tex python/trunk/Doc/lib/libmsilib.tex

[Jim Jewett]

a few nitpicks

On 5/1/06, martin.v.loewis <python-checkins at python.org> wrote:
> Author: martin.v.loewis
> Date: Mon May  1 18:12:44 2006
> New Revision: 45839
>
> Added:
>    python/trunk/Doc/lib/libmsilib.tex   (contents, props changed)

> Log:
> Add msilib documentation.

==============================================================================
> --- (empty file)
> +++ python/trunk/Doc/lib/libmsilib.tex  Mon May  1 18:12:44 2006

> +\index{msi}
> +
> +\versionadded{2.5}
> +
> +The \module{msilib} supports the creation of Microsoft Installer
> +(\code{.msi}) files.  Because these files often contain an embedded
> +``cabinet'' file (\code{.cab}), it also exposes an API to create
> +CAB files. Support for reading \code{.cab} files is currently not
> +implemented; read support for the \code{.msi} database is possible.

Is there an URL describing these formats?

[Note:  I apologize if it should have been obvious from the seealso
urls; for some reason I get only a top level table of contents on any
of them;  I suspect this is a local problem, though, since I'm not
using MSIE and it seems to apply to all of MSDN.]


> +\begin{funcdesc}{FCICreate}{cabname, files}
> +  Create a new CAB file named \var{cabname}. \var{files} must
> +  be a list of tuples, each containing the name of the file on
> +  disk, and the name of the file inside the CAB file.
> +
> +  The files are added to the CAB file in the order they have
> +  in the list. All files are added into a single CAB file,
> +  using the MSZIP compression algorithm.

Should that be "in the order that they appear in the list"/

Is there a good URL for the MSZIP format?

google pointed at non-MS sources, though one suggested 
http://msdn.microsoft.com/library/default.asp?url=/library/en-us/dncabsdk/html/cabdl.asp

> +\begin{funcdesc}{OpenDatabase}{path, persist}
> +  Return a new database object by calling MsiOpenDatabase.
> +  \var{path} is the file name of the
> +  MSI file; persist can be one of the constants
> +  \code{MSIDBOPEN_CREATEDIRECT}, \code{MSIDBOPEN_CREATE},
> +  \code{MSIDBOPEN_DIRECT}, \code{MSIDBOPEN_READONLY}, or
> +  \code{MSIDBOPEN_TRANSACT}, and may include the flag
> +  \code{MSIDBOPEN_PATCHFILE}. See the Microsoft documentation for
> +  the meaning of these flags; depending on the flags,
> +  an existing database is opened, or a new one created.
> +\end{funcdesc}

Any particular place in the documentation?  Preferably an URL

> +\begin{funcdesc}{add_tables}{database, module}
> +  Add all table content from \var{module} to \var{database}.
> +  \var{module} must contain an attribute \var{tables}
> +  listing all tables for which content should be added,
> +  and one attribute per table that has the actual content.
> +
> +  This is typically used to install the sequence
> +\end{funcdesc}

Is that last sentence complete?

-jJ