This issue tracker has been migrated to GitHub, and is currently read-only.
For more information, see the GitHub FAQs in the Python's Developer Guide.

classification
Title: Document bdist_msi
Type: enhancement Stage:
Components: Documentation Versions: Python 3.0, Python 3.1, Python 2.7, Python 2.6
process
Status: closed Resolution: fixed
Dependencies: Superseder:
Assigned To: georg.brandl Nosy List: bethard, georg.brandl, loewis
Priority: normal Keywords: patch

Created on 2009-03-25 23:32 by bethard, last changed 2022-04-11 14:56 by admin. This issue is now closed.

Files
File name Uploaded Description Edit
python3-bdist-msi-docs.patch bethard, 2009-03-31 21:43
Messages (9)
msg84168 - (view) Author: Steven Bethard (bethard) * (Python committer) Date: 2009-03-25 23:32
[Suggested in issue5095 by John Machin]

The 2.6.1 documentation consists of a *single* line:
"distutils.command.bdist_msi — Build a Microsoft Installer binary
package". The docs should explain briefly what an msi file is, and why a
packager might want to use it instead of wininst.
msg84172 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2009-03-26 01:06
Can you propose specific wording?
msg84173 - (view) Author: Steven Bethard (bethard) * (Python committer) Date: 2009-03-26 01:19
If no one beats me to it, I plan to do this at PyCon.
msg84439 - (view) Author: Steven Bethard (bethard) * (Python committer) Date: 2009-03-29 22:33
I'm thinking of stealing/condensing some of the text from here:
http://www.dcl.hpi.uni-potsdam.de/home/loewis/msipackage.html

Does that seem okay? Is any of that text no longer accurate? (E.g. does
bdist_wininst now support Win64?)
msg84444 - (view) Author: Martin v. Löwis (loewis) * (Python committer) Date: 2009-03-29 23:16
That should all be correct still (except that the status has advanced); 
using it for the documentation is fine. It's just that it is more 
rationale than specification.
msg84488 - (view) Author: Steven Bethard (bethard) * (Python committer) Date: 2009-03-30 04:14
The original docs request was for a rationale for using bdist_msi
instead of bdist_wininst, but you're right there should be something at
least a little specification-y. And we probably want to keep it pretty
short, so maybe something like::

  .. class: distutils.command.build_bdist_msi.bdist_msi(Command)

     Builds a `Microsoft Installer`_ (.msi) binary package.

     .. _Microsoft Installer:
     http://msdn.microsoft.com/en-us/library/cc185688(VS.85).aspx

     In most cases, the bdist_msi installer is a better choice than the 
     bdist_wininst installer, because it provides better support for 
     Win64 platforms, allows administrators to perform non-interactive
     installations, and allows installation through group policies.

I'm on the fence as to whether or not to include the URL to the MSI
info. That's probably as close to a specification as we can get, but
it's probably unnecessary for 99% of the people who might read the
bdist_msi docs.
msg84904 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-03-31 21:05
I'll wait for a patch from you, Steven.
msg84923 - (view) Author: Steven Bethard (bethard) * (Python committer) Date: 2009-03-31 21:43
Here you go. I built the docs with the attached patch, and everything
looks about right to me now.
msg84931 - (view) Author: Georg Brandl (georg.brandl) * (Python committer) Date: 2009-03-31 22:03
Committed in r70905.
History
Date User Action Args
2022-04-11 14:56:46adminsetgithub: 49813
2009-03-31 22:03:52georg.brandlsetstatus: open -> closed
resolution: fixed
messages: + msg84931
2009-03-31 21:43:37bethardsetfiles: + python3-bdist-msi-docs.patch
keywords: + patch
messages: + msg84923
2009-03-31 21:05:03georg.brandlsetmessages: + msg84904
2009-03-30 04:14:33bethardsetmessages: + msg84488
2009-03-29 23:16:28loewissetmessages: + msg84444
2009-03-29 22:33:14bethardsetmessages: + msg84439
2009-03-26 01:19:08bethardsetmessages: + msg84173
2009-03-26 01:06:09loewissetnosy: + loewis
messages: + msg84172
2009-03-25 23:32:57bethardcreate