diff options
| author | Daniel Holth <dholth@fastmail.fm> | 2012-09-15 08:05:11 -0400 |
|---|---|---|
| committer | Daniel Holth <dholth@fastmail.fm> | 2012-09-15 08:05:11 -0400 |
| commit | 91678ce3379e2243ad51545d2e46be3cc0f2e310 (patch) | |
| tree | d24334d92a1abfb708e2308322ec32a6207684a6 /docs | |
| parent | 90d7dbfe32f3251dccc578697a7c062fd1f37d9c (diff) | |
| download | wheel-git-91678ce3379e2243ad51545d2e46be3cc0f2e310.tar.gz | |
rename Packager to Generator in WHEEL; use Metadata 1.3
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/index.rst | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/index.rst b/docs/index.rst index bbdc896..20466f3 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -69,8 +69,8 @@ File Contents ------------- Wheel files contain a folder `{distribution}-{version}.dist-info/` with -the PEP 376 metadata and an additional file `WHEEL` with metadata about -the package itself. +the PEP 426 metadata (metadata version 1.3 or greater) and an additional +file `WHEEL` with metadata about the archive itself. The root of a .whl is either purelib or platlib. @@ -81,10 +81,16 @@ other files that are not installed on sys.path, they are found in Wheel files contain metadata about the wheel format itself in `{distribution}-{version}/WHEEL` :: - Wheel-Version: 0.9 - Packager: bdist_wheel + Wheel-Version: 0.1 + Generator: bdist_wheel 0.7 Root-Is-Purelib: true +``Wheel-Version`` is the version number of the Wheel +specification. ``Generator`` is the name and optionally the version of +the software that produced the archive. ``Root-Is-Purelib`` is ``true`` +if the top level directory of the archive should be installed into +``purelib``; otherwise the root should be installed into platlib. + A wheel installer should warn if `Wheel-Version` is greater than the version it supports, and fail if `Wheel-Version` has a greater major version than the version it supports. |