diff options
| author | Zbigniew Jędrzejewski-Szmek <zbyszek@in.waw.pl> | 2022-02-28 09:47:28 +0100 |
|---|---|---|
| committer | Luca Boccassi <luca.boccassi@gmail.com> | 2022-02-28 10:52:17 +0100 |
| commit | ee6fd6a50922d2b27c97084e1c3f9872d495c273 (patch) | |
| tree | d8badefd1930a2a0166b270309b3768252c567e4 /man/os-release.xml | |
| parent | Merge pull request #22627 from yuwata/network-l2tp-cleanups (diff) | |
| download | systemd-ee6fd6a50922d2b27c97084e1c3f9872d495c273.tar.xz systemd-ee6fd6a50922d2b27c97084e1c3f9872d495c273.zip | |
man: recommend built-in platform.freedesktop_os_release() in our page
Python gained support for reading os-release, let's advertise it a bit more.
Our open-coded example is still useful, but let's not suggest it as the
default implementation.
I added quotes around the printed string because it looks a bit better
this way.
Diffstat (limited to 'man/os-release.xml')
| -rw-r--r-- | man/os-release.xml | 16 |
1 files changed, 15 insertions, 1 deletions
diff --git a/man/os-release.xml b/man/os-release.xml index dd3c39f876..4acd1a9a57 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -502,9 +502,23 @@ VERSION_ID=32</programlisting> <example> <title>Reading <filename>os-release</filename> in - <citerefentry><refentrytitle>python</refentrytitle><manvolnum>1</manvolnum></citerefentry></title> + <citerefentry><refentrytitle>python</refentrytitle><manvolnum>1</manvolnum></citerefentry> (versions >= 3.10)</title> + + <programlisting><xi:include href="check-os-release-simple.py" parse="text" /></programlisting> + + <para>See docs for <ulink url="https://docs.python.org/3/library/platform.html#platform.freedesktop_os_release"> + <function>platform.freedesktop_os_release</function></ulink> for more details. + </para> + </example> + + <example> + <title>Reading <filename>os-release</filename> in + <citerefentry><refentrytitle>python</refentrytitle><manvolnum>1</manvolnum></citerefentry> (any version)</title> <programlisting><xi:include href="check-os-release.py" parse="text" /></programlisting> + + <para>Note that the above version that uses the built-in implementation is preferred + in most cases, and the open-coded version here is provided for reference.</para> </example> </refsect1> |