summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMarc-André Lemburg <mal@egenix.com>2009-02-17 12:48:19 (GMT)
committerMarc-André Lemburg <mal@egenix.com>2009-02-17 12:48:19 (GMT)
commit1d0b5cc6dcbabc217242ca5e141c900200ad4c26 (patch)
treeda02f008d16bf509c3dcaa10e20789b22aa6b5ea
parent6290178fc97e86cb5aff3cb279a8ee77d57311e5 (diff)
downloadcpython-1d0b5cc6dcbabc217242ca5e141c900200ad4c26.zip
cpython-1d0b5cc6dcbabc217242ca5e141c900200ad4c26.tar.gz
cpython-1d0b5cc6dcbabc217242ca5e141c900200ad4c26.tar.bz2
Clarify the deprecation of platform.dist().
Add versionadded tags.
-rw-r--r--Doc/library/platform.rst12
1 files changed, 11 insertions, 1 deletions
diff --git a/Doc/library/platform.rst b/Doc/library/platform.rst
index 3c98a1e..cd90c38 100644
--- a/Doc/library/platform.rst
+++ b/Doc/library/platform.rst
@@ -234,7 +234,15 @@ Unix Platforms
.. function:: dist(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...))
- This is another name for :func:`linux_distribution`.
+ This is an old version of the functionality now provided by
+ :func:`linux_distribution`. For new code, please use the
+ :func:`linux_distribution`.
+
+ The only difference between the two is that ``dist()`` always
+ returns the short name of the distribution taken from the
+ ``supported_dists`` parameter.
+
+ .. deprecated:: 2.6
.. function:: linux_distribution(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...), full_distribution_name=1)
@@ -252,6 +260,8 @@ Unix Platforms
parameters. ``id`` is the item in parentheses after the version number. It
is usually the version codename.
+ .. versionadded:: 2.6
+
.. function:: libc_ver(executable=sys.executable, lib='', version='', chunksize=2048)
Tries to determine the libc version against which the file executable (defaults