Commit 3e876fd1 authored by Benjamin Peterson's avatar Benjamin Peterson

clean up docs for platform's linux_distribution and dist functions

parent ffb3cca3
...@@ -234,29 +234,23 @@ Unix Platforms ...@@ -234,29 +234,23 @@ Unix Platforms
.. function:: dist(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...)) .. function:: dist(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...))
Tries to determine the name of the OS distribution name Returns a tuple This is another name for :func:`linux_distribution`.
``(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.
.. function:: linux_distribution(distname='', version='', id='', supported_dists=('SuSE','debian','redhat','mandrake',...), full_distribution_name=1) .. 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. Tries to determine the name of the Linux OS distribution name.
``supported_dists`` may be given to define the set of Linux ``supported_dists`` may be given to define the set of Linux distributions to
distributions to look for. It defaults to a list of currently look for. It defaults to a list of currently supported Linux distributions
supported Linux distributions identified by their release file identified by their release file name.
name.
If ``full_distribution_name`` is true (default), the full If ``full_distribution_name`` is true (default), the full distribution read
distribution read from the OS is returned. Otherwise the short name from the OS is returned. Otherwise the short name taken from
taken from ``supported_dists`` is used. ``supported_dists`` is used.
Returns a tuple ``(distname,version,id)`` which defaults to the Returns a tuple ``(distname,version,id)`` which defaults to the args given as
args given as parameters. 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) .. function:: libc_ver(executable=sys.executable, lib='', version='', chunksize=2048)
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment