diff options
| author | Bastian Venthur <venthur@debian.org> | 2019-05-18 22:37:49 +0200 |
|---|---|---|
| committer | Bastian Venthur <venthur@debian.org> | 2019-05-18 22:37:49 +0200 |
| commit | 6a3674a18d22dbea4d6b513b8e8a7ac28ada5eba (patch) | |
| tree | 25b4f10ff9921e9dcf2235787e7725957f6ec7ce | |
| parent | 73dbe0ec07e3738bc592e92def65209b45a14dfb (diff) | |
| download | external_python_setuptools-6a3674a18d22dbea4d6b513b8e8a7ac28ada5eba.tar.gz external_python_setuptools-6a3674a18d22dbea4d6b513b8e8a7ac28ada5eba.tar.bz2 external_python_setuptools-6a3674a18d22dbea4d6b513b8e8a7ac28ada5eba.zip | |
Added meat to obsoletes and provides, removed that they should not be used.
| -rw-r--r-- | docs/keywords.txt | 42 |
1 files changed, 39 insertions, 3 deletions
diff --git a/docs/keywords.txt b/docs/keywords.txt index db50163a..d56014e0 100644 --- a/docs/keywords.txt +++ b/docs/keywords.txt @@ -105,13 +105,49 @@ ``obsoletes`` .. warning:: - ``obsoletes`` is not supported by ``pip`` and should not be used. + ``obsoletes`` is currently ignored by ``pip``. + + List of strings describing packages which this package renders obsolete, + meaning that the two projects should not be installed at the same time. + + Version declarations can be supplied. Version numbers must be in the format + specified in Version specifiers (e.g. ``foo (<3.0)``). + + This field may be followed by an environment marker after a semicolon (e.g. + ``foo; os_name == "posix"``) + + The most common use of this field will be in case a project name changes, + e.g. Gorgon 2.3 gets subsumed into Torqued Python 1.0. When you install + Torqued Python, the Gorgon distribution should be removed. ``provides`` .. warning:: - ``provides`` is not supported by ``pip`` and should not be used. - + ``provides`` is currently ignored by ``pip``. + + List of strings describing package- and virtual package names contained + within this package. + + A package may provide additional names, e.g. to indicate that multiple + projects have been bundled together. For instance, source distributions of + the ZODB project have historically included the transaction project, which + is now available as a separate distribution. Installing such a source + distribution satisfies requirements for both ZODB and transaction. + + A package may also provide a “virtual” project name, which does not + correspond to any separately-distributed project: such a name might be used + to indicate an abstract capability which could be supplied by one of + multiple projects. E.g., multiple projects might supply RDBMS bindings for + use by a given ORM: each project might declare that it provides + ORM-bindings, allowing other projects to depend only on having at most one + of them installed. + + A version declaration may be supplied and must follow the rules described in + Version specifiers. The distribution’s version number will be implied if + none is specified (e.g. ``foo (<3.0)``). + + Each package may be followed by an environment marker after a semicolon + (e.g. ``foo; os_name == "posix"``). .. Below are setuptools keywords, above are distutils |
