diff options
| author | Benjamin Peterson <benjamin@python.org> | 2008-09-22 22:13:29 (GMT) |
|---|---|---|
| committer | Benjamin Peterson <benjamin@python.org> | 2008-09-22 22:13:29 (GMT) |
| commit | 3e876fd146ea9b77b2467cd999425831a80abbcb (patch) | |
| tree | 3972feb4e02f3b56434bec65fbaa00151749d3cd /Doc | |
| parent | ffb3cca39bcaeac8893e223618c51f1497f88ec3 (diff) | |
| download | cpython-3e876fd146ea9b77b2467cd999425831a80abbcb.zip cpython-3e876fd146ea9b77b2467cd999425831a80abbcb.tar.gz cpython-3e876fd146ea9b77b2467cd999425831a80abbcb.tar.bz2 | |
clean up docs for platform's linux_distribution and dist functions
Diffstat (limited to 'Doc')
| -rw-r--r-- | Doc/library/platform.rst | 26 |
1 files changed, 10 insertions, 16 deletions
diff --git a/Doc/library/platform.rst b/Doc/library/platform.rst index e80fc11..3c98a1e 100644 --- a/Doc/library/platform.rst +++ b/Doc/library/platform.rst @@ -234,29 +234,23 @@ Unix Platforms .. 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. + ``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. + 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. + 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) |