[Python-checkins] CVS: python/nondist/peps pep-0241.txt,1.5,1.6
A.M. Kuchling
akuchling@users.sourceforge.net
Sat, 17 Mar 2001 08:30:30 -0800
Update of /cvsroot/python/python/nondist/peps
In directory usw-pr-cvs1:/tmp/cvs-serv1137
Modified Files:
pep-0241.txt
Log Message:
More suggestions from Sean R.:
* Rewrite introductory paragraph
* Make some fields optional and others multiple-user
* Add header name to examples
Index: pep-0241.txt
===================================================================
RCS file: /cvsroot/python/python/nondist/peps/pep-0241.txt,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -r1.5 -r1.6
*** pep-0241.txt 2001/03/17 16:04:42 1.5
--- pep-0241.txt 2001/03/17 16:30:28 1.6
***************
*** 10,15 ****
Introduction
! This PEP specifies the names and semantics of the fields used to store
! metadata about Python software packages.
--- 10,16 ----
Introduction
! This PEP describes a mechanism for adding metadata to Python
! packages. It includes specifics of the field names, and their
! semantics and usage.
***************
*** 23,30 ****
go).
! Developers may not provide their own "PKG-INFO" file. The "sdist"
! command will, if it detects an existing "PKG-INFO" file, terminate
with an appropriate error message. This should prevent confusion
! caused by the "PKG-INFO" and "setup.py" files being out of sync.
The PKG-INFO file format is a single set of RFC-822 headers
--- 24,31 ----
go).
! Developers may not provide their own PKG-INFO file. The "sdist"
! command will, if it detects an existing PKG-INFO file, terminate
with an appropriate error message. This should prevent confusion
! caused by the PKG-INFO and setup.py files being out of sync.
The PKG-INFO file format is a single set of RFC-822 headers
***************
*** 39,49 ****
This section specifies the names and semantics of each of the
supported metadata fields.
Metadata-Version
Version of the file format; currently "1.0" is the only
! legal value here.
! Example: '1.0'
Name
--- 40,56 ----
This section specifies the names and semantics of each of the
supported metadata fields.
+
+ Fields marked with "(Multiple use)" may be specified multiple
+ times in a single PKG-INFO file. Other fields may only occur
+ once in a PKG-INFO file. Fields marked with "(optional)" are
+ not required to appear in a valid PKG-INFO file, all other
+ fields must be present.
Metadata-Version
Version of the file format; currently "1.0" is the only
! legal value here.
! Example: 'Metadata-Version: 1.0'
Name
***************
*** 51,55 ****
The name of the package.
! Example: 'BeagleVote'
Version
--- 58,62 ----
The name of the package.
! Example: 'Name: BeagleVote'
Version
***************
*** 60,66 ****
module.
! Example: '1.0a2'
! Platforms
A (XXX whitespace? comma?)-separated list of platform
--- 67,73 ----
module.
! Example: 'Version: 1.0a2'
! Platform (multiple use)
A (XXX whitespace? comma?)-separated list of platform
***************
*** 76,80 ****
A one-line summary of what the package does.
! Example: "A module for collecting votes from beagles."
Description (optional)
--- 83,87 ----
A one-line summary of what the package does.
! Example: "Summary: A module for collecting votes from beagles."
Description (optional)
***************
*** 86,99 ****
long-description.)
! Example: 'This module collects votes from beagles in order to
! determine their electoral wishes. Do NOT try to use this module
! with basset hounds; it makes them grumpy.'
! Keywords
A list of additional keywords to be used to assist searching
for this package in a larger catalog.
! Example: 'dog puppy voting election'
Home-page (optional)
--- 93,107 ----
long-description.)
! Example: "Description: This module collects votes from beagles\n
! in order to determine their electoral wishes.\n
! Do NOT try to use this module with basset hounds;
! it makes them grumpy."
! Keywords (optional)
A list of additional keywords to be used to assist searching
for this package in a larger catalog.
! Example: 'Keywords: dog puppy voting election'
Home-page (optional)
***************
*** 101,105 ****
A string containing the URL for the package's home page.
! Example: 'http://www.example.com/~cschultz/bvote/'
Author (optional)
--- 109,113 ----
A string containing the URL for the package's home page.
! Example: 'Home-page: http://www.example.com/~cschultz/bvote/'
Author (optional)
***************
*** 109,113 ****
newlines.
! Example: 'C. Schultz\nUniversal Features Syndicate\nLos Angeles, CA'
Author-email
--- 117,123 ----
newlines.
! Example: 'Author: C. Schultz
! Universal Features Syndicate
! Los Angeles, CA'
Author-email
***************
*** 124,128 ****
PEP.
! Example: '"C. Schultz" <cschultz@example.com>'
License
--- 134,138 ----
PEP.
! Example: 'Author-email: "C. Schultz" <cschultz@example.com>'
License
***************
*** 160,167 ****
nosource, shareware
-
Note that being redistributable does not mean a package
qualifies as free software, 'nosource' and 'shareware' being
examples.
--- 170,178 ----
nosource, shareware
Note that being redistributable does not mean a package
qualifies as free software, 'nosource' and 'shareware' being
examples.
+
+ Example: 'License: MIT/X11'