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

Tue Sep 23 00:13:30 CEST 2008

Author: benjamin.peterson
Date: Tue Sep 23 00:13:29 2008
New Revision: 66561
Log:
clean up docs for platform's linux_distribution and dist functions
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 Sep 23 00:13:29 2008
@@ -234,29 +234,23 @@
 
 .. function:: dist(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...))
 
- Tries to determine the name of the OS distribution name Returns a tuple
- ``(distname, version, id)`` which defaults to the args given as parameters.
-
- ``supported_dists`` may be given to define the set of Linux
- distributions to look for. It defaults to a list of currently
- supported Linux distributions identified by their release file
- name.
+ This is another name for :func:`linux_distribution`.
 
 .. function:: linux_distribution(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...), full_distribution_name=1)
 
 Tries to determine the name of the Linux OS distribution name.
 
- ``supported_dists`` may be given to define the set of Linux
- distributions to look for. It defaults to a list of currently
- supported Linux distributions identified by their release file
- name.
-
- If ``full_distribution_name`` is true (default), the full
- distribution read from the OS is returned. Otherwise the short name
- taken from ``supported_dists`` is used.
-
- Returns a tuple ``(distname,version,id)`` which defaults to the
- args given as parameters.
+ ``supported_dists`` may be given to define the set of Linux distributions to
+ look for. It defaults to a list of currently supported Linux distributions
+ identified by their release file name.
+
+ If ``full_distribution_name`` is true (default), the full distribution read
+ from the OS is returned. Otherwise the short name taken from
+ ``supported_dists`` is used.
+
+ Returns a tuple ``(distname,version,id)`` which defaults to the args given as
+ parameters. ``id`` is the item in parentheses after the version number. It
+ is usually the version codename.
 
 .. function:: libc_ver(executable=sys.executable, lib='', version='', chunksize=2048)
 
