https://github.com/python/cpython/commit/1550c30fd5f2f2902bbcbf64165ae904ebcf7e81
commit: 1550c30fd5f2f2902bbcbf64165ae904ebcf7e81
branch: main
author: Semyon Moroz <donbar...@proton.me>
committer: hugovk <1324225+hug...@users.noreply.github.com>
date: 2025-05-03T15:05:04+03:00
summary:
gh-130160: use `.. program::` directive for documenting `platform` CLI (#133335)
files:
M Doc/library/cmdline.rst
M Doc/library/platform.rst
diff --git a/Doc/library/cmdline.rst b/Doc/library/cmdline.rst
index 85e82f6292a5ec..f7ae2133a70b7a 100644
--- a/Doc/library/cmdline.rst
+++ b/Doc/library/cmdline.rst
@@ -27,7 +27,7 @@ The following modules have a command-line interface.
* :mod:`pdb`
* :ref:`pickle <pickle-cli>`
* :ref:`pickletools <pickletools-cli>`
-* :mod:`platform`
+* :ref:`platform <platform-cli>`
* :mod:`poplib`
* :ref:`profile <profile-cli>`
* :mod:`pstats`
diff --git a/Doc/library/platform.rst b/Doc/library/platform.rst
index cfe1e7ba48da32..5c999054323be5 100644
--- a/Doc/library/platform.rst
+++ b/Doc/library/platform.rst
@@ -17,7 +17,7 @@
section.
-Cross Platform
+Cross platform
--------------
@@ -188,7 +188,7 @@ Cross Platform
:attr:`processor` is resolved late instead of immediately.
-Java Platform
+Java platform
-------------
@@ -206,7 +206,7 @@ Java Platform
and was only useful for Jython support.
-Windows Platform
+Windows platform
----------------
@@ -240,7 +240,7 @@ Windows Platform
.. versionadded:: 3.8
-macOS Platform
+macOS platform
--------------
.. function:: mac_ver(release='', versioninfo=('','',''), machine='')
@@ -252,7 +252,7 @@ macOS Platform
Entries which cannot be determined are set to ``''``. All tuple entries are
strings.
-iOS Platform
+iOS platform
------------
.. function:: ios_ver(system='', release='', model='', is_simulator=False)
@@ -271,7 +271,7 @@ iOS Platform
parameters.
-Unix Platforms
+Unix platforms
--------------
.. function:: libc_ver(executable=sys.executable, lib='', version='',
chunksize=16384)
@@ -287,7 +287,7 @@ Unix Platforms
The file is read and scanned in chunks of *chunksize* bytes.
-Linux Platforms
+Linux platforms
---------------
.. function:: freedesktop_os_release()
@@ -325,7 +325,7 @@ Linux Platforms
.. versionadded:: 3.10
-Android Platform
+Android platform
----------------
.. function:: android_ver(release="", api_level=0, manufacturer="", \
@@ -360,6 +360,34 @@ Android Platform
.. versionadded:: 3.13
+.. _platform-cli:
+
+Command-line usage
+------------------
+
+:mod:`platform` can also be invoked directly using the :option:`-m`
+switch of the interpreter::
+
+ python -m platform [--terse] [--nonaliased] [{nonaliased,terse} ...]
+
+The following options are accepted:
+
+.. program:: platform
+
+.. option:: --terse
+
+ Print terse information about the platform. This is equivalent to
+ calling :func:`platform.platform` with the *terse* argument set to ``True``.
+
+.. option:: --nonaliased
+
+ Print platform information without system/OS name aliasing. This is
+ equivalent to calling :func:`platform.platform` with the *aliased* argument
+ set to ``True``.
+
+You can also pass one or more positional arguments (``terse``, ``nonaliased``)
+to explicitly control the output format. These behave similarly to their
+corresponding options.
Miscellaneous
-------------
_______________________________________________
Python-checkins mailing list -- python-checkins@python.org
To unsubscribe send an email to python-checkins-le...@python.org
https://mail.python.org/mailman3/lists/python-checkins.python.org/
Member address: arch...@mail-archive.com
