[Python-checkins] r69717 - python/trunk/Doc/library/platform.rst

[marc-andre.lemburg]

Author: marc-andre.lemburg
Date: Tue Feb 17 13:48:19 2009
New Revision: 69717

Log:
Clarify the deprecation of platform.dist().

Add versionadded tags.



Modified:
   python/trunk/Doc/library/platform.rst

Modified: python/trunk/Doc/library/platform.rst
==============================================================================
--- python/trunk/Doc/library/platform.rst	(original)
+++ python/trunk/Doc/library/platform.rst	Tue Feb 17 13:48:19 2009
@@ -234,7 +234,15 @@
 
 .. 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 @@
    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