From 00e3abe024bd7550adf2eade560b176699270fcc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 20 May 2021 14:57:06 +0200 Subject: [PATCH 1/6] man: reorder fields in os-release Let's order the fields from the most general to least: os name, os variant, os version, machine-parseable version details, metadata, special settings. I added section headers to roughly group the settings. The division is not strict, because for example CPE_NAME also includes the version, and PRETTY_NAME may too, but it still makes it easier to find the right name. Also split out Examples to separate paragraphs: almost all descriptions had "Example:" at the end, where multiple examples were listed. Splitting this out to separate paragraphs makes the whole thing much easier to read. Add missing markup and punctuation while at it. About - If not set, defaults to NAME=Linux. + If not set, a default of NAME=Linux may be used. and similar changes: in many circumstances, if this is not set, no value should be used. The fallback mostly make sense when we need to present something to the user. So let's reword this to not imply that the default is necessary. --- man/os-release.xml | 520 ++++++++++++++++++++++----------------------- 1 file changed, 254 insertions(+), 266 deletions(-) diff --git a/man/os-release.xml b/man/os-release.xml index cda0779303..a5b2437632 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -87,315 +87,303 @@ The following OS identifications parameters may be set using os-release: - + + General information identifying the operating system - - NAME= + + + NAME= - A string identifying the operating system, - without a version component, and suitable for presentation to - the user. If not set, defaults to - NAME=Linux. Example: - NAME=Fedora or NAME="Debian - GNU/Linux". - + A string identifying the operating system, without a version component, and + suitable for presentation to the user. If not set, a default of NAME=Linux may + be used. - - VERSION= + Examples: NAME=Fedora, NAME="Debian GNU/Linux". + + - A string identifying the operating system - version, excluding any OS name information, possibly including - a release code name, and suitable for presentation to the - user. This field is optional. Example: - VERSION=17 or VERSION="17 (Beefy - Miracle)". - + + ID= - - ID= + A lower-case string (no spaces or other characters outside of 0–9, a–z, ".", "_" + and "-") identifying the operating system, excluding any version information and suitable for + processing by scripts or usage in generated filenames. If not set, a default of + ID=linux may be used. - A lower-case string (no spaces or other - characters outside of 0–9, a–z, ".", "_" and "-") identifying - the operating system, excluding any version information and - suitable for processing by scripts or usage in generated - filenames. If not set, defaults to - ID=linux. Example: - ID=fedora or - ID=debian. - + Examples: ID=fedora, ID=debian. + - - ID_LIKE= + + ID_LIKE= - A space-separated list of operating system - identifiers in the same syntax as the ID= - setting. It should list identifiers of operating systems that - are closely related to the local operating system in regards - to packaging and programming interfaces, for example listing - one or more OS identifiers the local OS is a derivative from. - An OS should generally only list other OS identifiers it - itself is a derivative of, and not any OSes that are derived - from it, though symmetric relationships are possible. Build - scripts and similar should check this variable if they need to - identify the local operating system and the value of - ID= is not recognized. Operating systems - should be listed in order of how closely the local operating - system relates to the listed ones, starting with the closest. - This field is optional. Example: for an operating system with - ID=centos, an assignment of - ID_LIKE="rhel fedora" would be appropriate. - For an operating system with ID=ubuntu, an - assignment of ID_LIKE=debian is - appropriate. - + A space-separated list of operating system identifiers in the same syntax as the + ID= setting. It should list identifiers of operating systems that are closely + related to the local operating system in regards to packaging and programming interfaces, for + example listing one or more OS identifiers the local OS is a derivative from. An OS should + generally only list other OS identifiers it itself is a derivative of, and not any OSes that are + derived from it, though symmetric relationships are possible. Build scripts and similar should + check this variable if they need to identify the local operating system and the value of + ID= is not recognized. Operating systems should be listed in order of how + closely the local operating system relates to the listed ones, starting with the closest. This + field is optional. - - VERSION_CODENAME= + Examples: for an operating system with ID=centos, an assignment of + ID_LIKE="rhel fedora" would be appropriate. For an operating system with + ID=ubuntu, an assignment of ID_LIKE=debian is appropriate. + + - - A lower-case string (no spaces or other characters outside of - 0–9, a–z, ".", "_" and "-") identifying the operating system - release code name, excluding any OS name information or - release version, and suitable for processing by scripts or - usage in generated filenames. This field is optional and may - not be implemented on all systems. - Examples: - VERSION_CODENAME=buster, - VERSION_CODENAME=xenial - - + + PRETTY_NAME= - - VERSION_ID= + A pretty operating system name in a format suitable for presentation to the + user. May or may not contain a release code name or OS version of some kind, as suitable. If not + set, a default of PRETTY_NAME="Linux" may be used - A lower-case string (mostly numeric, no spaces - or other characters outside of 0–9, a–z, ".", "_" and "-") - identifying the operating system version, excluding any OS - name information or release code name, and suitable for - processing by scripts or usage in generated filenames. This - field is optional. Example: VERSION_ID=17 - or VERSION_ID=11.04. - + Example: PRETTY_NAME="Fedora 17 (Beefy Miracle)". + - - PRETTY_NAME= + + CPE_NAME= - A pretty operating system name in a format - suitable for presentation to the user. May or may not contain - a release code name or OS version of some kind, as suitable. - If not set, defaults to - PRETTY_NAME="Linux". Example: - PRETTY_NAME="Fedora 17 (Beefy - Miracle)". - + A CPE name for the operating system, in URI binding syntax, following the Common Platform Enumeration Specification as + proposed by the NIST. This field is optional. - - ANSI_COLOR= + Example: CPE_NAME="cpe:/o:fedoraproject:fedora:17" + - A suggested presentation color when showing the OS name on the console. This should - be specified as string suitable for inclusion in the ESC [ m ANSI/ECMA-48 escape code for setting - graphical rendition. This field is optional. Example: ANSI_COLOR="0;31" for red, - ANSI_COLOR="1;34" for light blue, or - ANSI_COLOR="0;38;2;60;110;180" for Fedora blue. - + + VARIANT= - - CPE_NAME= + A string identifying a specific variant or edition of the operating system suitable + for presentation to the user. This field may be used to inform the user that the configuration of + this system is subject to a specific divergent set of rules or default configuration settings. This + field is optional and may not be implemented on all systems. - A CPE name for the operating system, in URI - binding syntax, following the - Common - Platform Enumeration Specification as proposed by the - NIST. This field is optional. Example: - CPE_NAME="cpe:/o:fedoraproject:fedora:17" - - + Examples: VARIANT="Server Edition", VARIANT="Smart Refrigerator + Edition". - - HOME_URL= - DOCUMENTATION_URL= - SUPPORT_URL= - BUG_REPORT_URL= - PRIVACY_POLICY_URL= + Note: this field is for display purposes only. The VARIANT_ID field should + be used for making programmatic decisions. + - Links to resources on the Internet related to - the operating system. - HOME_URL= should refer to the homepage of - the operating system, or alternatively some homepage of the - specific version of the operating system. - DOCUMENTATION_URL= should refer to the main - documentation page for this operating system. - SUPPORT_URL= should refer to the main - support page for the operating system, if there is any. This - is primarily intended for operating systems which vendors - provide support for. BUG_REPORT_URL= should - refer to the main bug reporting page for the operating system, - if there is any. This is primarily intended for operating - systems that rely on community QA. - PRIVACY_POLICY_URL= should refer to the - main privacy policy page for the operating system, if there is - any. These settings are optional, and providing only some of - these settings is common. These URLs are intended to be - exposed in "About this system" UIs behind links with captions - such as "About this Operating System", "Obtain Support", - "Report a Bug", or "Privacy Policy". The values should be in - RFC3986 - format, and should be http: or - https: URLs, and possibly - mailto: or tel:. Only - one URL shall be listed in each setting. If multiple resources - need to be referenced, it is recommended to provide an online - landing page linking all available resources. Examples: - HOME_URL="https://fedoraproject.org/" and - BUG_REPORT_URL="https://bugzilla.redhat.com/" - + + VARIANT_ID= - - BUILD_ID= + A lower-case string (no spaces or other characters outside of 0–9, a–z, ".", "_" and + "-"), identifying a specific variant or edition of the operating system. This may be interpreted by + other packages in order to determine a divergent default configuration. This field is optional and + may not be implemented on all systems. - A string uniquely identifying the system image - used as the origin for a distribution (it is not updated with - system updates). The field can be identical between different - VERSION_IDs as BUILD_ID is an only a unique identifier to a - specific version. Distributions that release each update as a - new version would only need to use VERSION_ID as each build is - already distinct based on the VERSION_ID. This field is - optional. Example: BUILD_ID="2013-03-20.3" - or BUILD_ID=201303203. + Examples: VARIANT_ID=server, VARIANT_ID=embedded. + + + + - - + + Information about the version of the operating system - - VARIANT= + + + VERSION= - - A string identifying a specific variant or edition of the - operating system suitable for presentation to the user. This - field may be used to inform the user that the configuration of - this system is subject to a specific divergent set of rules or - default configuration settings. This field is optional and may - not be implemented on all systems. - Examples: - VARIANT="Server Edition", - VARIANT="Smart Refrigerator Edition" - Note: this field is for display purposes only. The - VARIANT_ID field should be used for making - programmatic decisions. - - + A string identifying the operating system version, excluding any OS name + information, possibly including a release code name, and suitable for presentation to the + user. This field is optional. - - VARIANT_ID= + Examples: VERSION=17, VERSION="17 (Beefy Miracle)". + + - - A lower-case string (no spaces or other characters outside of - 0–9, a–z, ".", "_" and "-"), identifying a specific variant or - edition of the operating system. This may be interpreted by - other packages in order to determine a divergent default - configuration. This field is optional and may not be - implemented on all systems. - Examples: - VARIANT_ID=server, - VARIANT_ID=embedded - - + + VERSION_ID= - - LOGO= + A lower-case string (mostly numeric, no spaces or other characters outside of 0–9, + a–z, ".", "_" and "-") identifying the operating system version, excluding any OS name information + or release code name, and suitable for processing by scripts or usage in generated filenames. This + field is optional. - - A string, specifying the name of an icon as defined by - freedesktop.org Icon Theme Specification. This can be - used by graphical applications to display an operating - system's or distributor's logo. This field is optional and - may not necessarily be implemented on all systems. - Examples: - LOGO=fedora-logo, - LOGO=distributor-logo-opensuse - - + Examples: VERSION_ID=17, VERSION_ID=11.04. + + - - DEFAULT_HOSTNAME= + + VERSION_CODENAME= - A string specifying the hostname if - hostname5 is not - present and no other configuration source specifies the hostname. Must be either a single DNS label - (a string composed of 7-bit ASCII lower-case characters and no spaces or dots, limited to the format - allowed for DNS domain name labels), or a sequence of such labels separated by single dots that forms - a valid DNS FQDN. The hostname must be at most 64 characters, which is a Linux limitation (DNS allows - longer names). + A lower-case string (no spaces or other characters outside of 0–9, a–z, ".", "_" + and "-") identifying the operating system release code name, excluding any OS name information or + release version, and suitable for processing by scripts or usage in generated filenames. This field + is optional and may not be implemented on all systems. - See - org.freedesktop.hostname15 - for a description of how - systemd-hostnamed.service8 - determines the fallback hostname. - + Examples: VERSION_CODENAME=buster, + VERSION_CODENAME=xenial. + - - SYSEXT_LEVEL= + + BUILD_ID= - A lower-case string (mostly numeric, no spaces or other characters outside of 0–9, - a–z, ".", "_" and "-") identifying the operating system extensions support level, to indicate which - extension images are supported (See: - systemd-sysext8). - Example: SYSEXT_LEVEL=2 or - SYSEXT_LEVEL=15.14. - + A string uniquely identifying the system image used as the origin for a distribution + (it is not updated with system updates). The field can be identical between different + VERSION_IDs as BUILD_ID is an only a unique identifier to a + specific version. Distributions that release each update as a new version would only need to use + VERSION_ID as each build is already distinct based on the + VERSION_ID. This field is optional. - - IMAGE_ID= + Examples: BUILD_ID="2013-03-20.3", BUILD_ID=201303203. + + - A lower-case string (no spaces or other characters outside of 0–9, a–z, ".", "_" and - "-"), identifying a specific image of the operating system. This is supposed to be used for - environments where OS images are prepared, built, shipped and updated as comprehensive, consistent OS - images. This field is optional and may not be implemented on all systems, in particularly not on those - that are not managed via images but put together and updated from individual packages and on the - local system. Examples: IMAGE_ID=vendorx-cashier-system, - IMAGE_ID=netbook-image - + + IMAGE_ID= - - IMAGE_VERSION= + A lower-case string (no spaces or other characters outside of 0–9, a–z, ".", "_" + and "-"), identifying a specific image of the operating system. This is supposed to be used for + environments where OS images are prepared, built, shipped and updated as comprehensive, consistent + OS images. This field is optional and may not be implemented on all systems, in particularly not on + those that are not managed via images but put together and updated from individual packages and on + the local system. - A lower-case string (mostly numeric, no spaces or other characters outside of 0–9, - a–z, ".", "_" and "-") identifying the OS image version. This is supposed to be used together with - IMAGE_ID described above, to discern different versions of the same - image. Examples: IMAGE_VERSION=33, - IMAGE_VERSION=47.1rc1 - + Examples: IMAGE_ID=vendorx-cashier-system, + IMAGE_ID=netbook-image. + - + + IMAGE_VERSION= - If you are reading this file from C code or a shell script - to determine the OS or a specific version of it, use the - ID and VERSION_ID fields, - possibly with ID_LIKE as fallback for - ID. When looking for an OS identification - string for presentation to the user use the - PRETTY_NAME field. + A lower-case string (mostly numeric, no spaces or other characters outside of 0–9, + a–z, ".", "_" and "-") identifying the OS image version. This is supposed to be used together with + IMAGE_ID described above, to discern different versions of the same image. + - Note that operating system vendors may choose not to provide - version information, for example to accommodate for rolling - releases. In this case, VERSION and - VERSION_ID may be unset. Applications should - not rely on these fields to be set. + Examples: IMAGE_VERSION=33, IMAGE_VERSION=47.1rc1. + + + + - Operating system vendors may extend the file - format and introduce new fields. It is highly - recommended to prefix new fields with an OS specific - name in order to avoid name clashes. Applications - reading this file must ignore unknown fields. Example: - DEBIAN_BTS="debbugs://bugs.debian.org/" + + Presentation information and links - Container and sandbox runtime managers may make the host's - identification data available to applications by providing the host's - /etc/os-release (if available, otherwise - /usr/lib/os-release as a fallback) as - /run/host/os-release. + + + HOME_URL= + DOCUMENTATION_URL= + SUPPORT_URL= + BUG_REPORT_URL= + PRIVACY_POLICY_URL= + + Links to resources on the Internet related to the operating system. + HOME_URL= should refer to the homepage of the operating system, or alternatively + some homepage of the specific version of the operating system. + DOCUMENTATION_URL= should refer to the main documentation page for this + operating system. SUPPORT_URL= should refer to the main support page for the + operating system, if there is any. This is primarily intended for operating systems which vendors + provide support for. BUG_REPORT_URL= should refer to the main bug reporting page + for the operating system, if there is any. This is primarily intended for operating systems that + rely on community QA. PRIVACY_POLICY_URL= should refer to the main privacy + policy page for the operating system, if there is any. These settings are optional, and providing + only some of these settings is common. These URLs are intended to be exposed in "About this system" + UIs behind links with captions such as "About this Operating System", "Obtain Support", "Report a + Bug", or "Privacy Policy". The values should be in RFC3986 format, and should be + http: or https: URLs, and possibly mailto: + or tel:. Only one URL shall be listed in each setting. If multiple resources + need to be referenced, it is recommended to provide an online landing page linking all available + resources. + + Examples: HOME_URL="https://fedoraproject.org/", + BUG_REPORT_URL="https://bugzilla.redhat.com/". + + + + LOGO= + + A string, specifying the name of an icon as defined by freedesktop.org Icon Theme + Specification. This can be used by graphical applications to display an operating system's + or distributor's logo. This field is optional and may not necessarily be implemented on all + systems. + + Examples: LOGO=fedora-logo, LOGO=distributor-logo-opensuse + + + + + ANSI_COLOR= + + A suggested presentation color when showing the OS name on the console. This should + be specified as string suitable for inclusion in the ESC [ m ANSI/ECMA-48 escape code for setting + graphical rendition. This field is optional. + + Examples: ANSI_COLOR="0;31" for red, ANSI_COLOR="1;34" + for light blue, or ANSI_COLOR="0;38;2;60;110;180" for Fedora blue. + + + + + + + Distribution-level defaults and metadata + + + + DEFAULT_HOSTNAME= + + A string specifying the hostname if + hostname5 is not + present and no other configuration source specifies the hostname. Must be either a single DNS label + (a string composed of 7-bit ASCII lower-case characters and no spaces or dots, limited to the + format allowed for DNS domain name labels), or a sequence of such labels separated by single dots + that forms a valid DNS FQDN. The hostname must be at most 64 characters, which is a Linux + limitation (DNS allows longer names). + + See org.freedesktop.hostname15 + for a description of how + systemd-hostnamed.service8 + determines the fallback hostname. + + + + SYSEXT_LEVEL= + + A lower-case string (mostly numeric, no spaces or other characters outside of 0–9, + a–z, ".", "_" and "-") identifying the operating system extensions support level, to indicate which + extension images are supported. See: + systemd-sysext8) + for more information. + + Examples: SYSEXT_LEVEL=2, SYSEXT_LEVEL=15.14. + + + + + + + Notes + + If you are reading this file from C code or a shell script to determine the OS or a specific + version of it, use the ID and VERSION_ID fields, possibly with + ID_LIKE as fallback for ID. When looking for an OS identification + string for presentation to the user use the PRETTY_NAME field. + + Note that operating system vendors may choose not to provide version information, for example to + accommodate for rolling releases. In this case, VERSION and + VERSION_ID may be unset. Applications should not rely on these fields to be + set. + + Operating system vendors may extend the file format and introduce new fields. It is highly + recommended to prefix new fields with an OS specific name in order to avoid name clashes. Applications + reading this file must ignore unknown fields. + + Example: DEBIAN_BTS="debbugs://bugs.debian.org/". + + Container and sandbox runtime managers may make the host's identification data available to + applications by providing the host's /etc/os-release (if available, otherwise + /usr/lib/os-release as a fallback) as + /run/host/os-release. + From e839ebe5511028f6032ae53ebb43601c1f4624be Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 20 May 2021 19:47:55 +0200 Subject: [PATCH 2/6] man: add an example how to correctly read os-release in shell This is not entirely obvious. The logic of how to interpret the fields applies in any language, so drop the pointless mention of C or shell. --- man/check-os-release.sh | 10 ++++++++++ man/os-release.xml | 21 ++++++++++++++++----- 2 files changed, 26 insertions(+), 5 deletions(-) create mode 100644 man/check-os-release.sh diff --git a/man/check-os-release.sh b/man/check-os-release.sh new file mode 100644 index 0000000000..2a1a057928 --- /dev/null +++ b/man/check-os-release.sh @@ -0,0 +1,10 @@ +#!/bin/sh -eu + +test -e /etc/os-release && os_release='/etc/os-release' || os_release='/usr/lib/os-release' +. "${os_release}" + +echo "Running on ${PRETTY_NAME:-Linux}" + +if [ "${ID:-linux}" = "debian" ] || [ "${ID_LIKE:-}" = "debian" ]; then + echo "Looks like Debian!" +fi diff --git a/man/os-release.xml b/man/os-release.xml index a5b2437632..36e5bed62e 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -3,7 +3,7 @@ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd"> - + os-release systemd @@ -363,8 +363,8 @@ Notes - If you are reading this file from C code or a shell script to determine the OS or a specific - version of it, use the ID and VERSION_ID fields, possibly with + If you are using this file to determine the OS or a specific version of it, use the + ID and VERSION_ID fields, possibly with ID_LIKE as fallback for ID. When looking for an OS identification string for presentation to the user use the PRETTY_NAME field. @@ -387,9 +387,12 @@ - Example + Examples - NAME=Fedora + + <filename>os-release</filename> file for Fedora Workstation + + NAME=Fedora VERSION="32 (Workstation Edition)" ID=fedora VERSION_ID=32 @@ -408,6 +411,14 @@ REDHAT_SUPPORT_PRODUCT_VERSION=32 PRIVACY_POLICY_URL="https://fedoraproject.org/wiki/Legal:PrivacyPolicy" VARIANT="Workstation Edition" VARIANT_ID=workstation + + + + Reading <filename>os-release</filename> in + <citerefentry><refentrytitle>sh</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + + From 3ca606d103cb9c4011cfcb1d377b6749fb73aaec Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 20 May 2021 20:00:18 +0200 Subject: [PATCH 3/6] man: add example os-release mangling in python This is also not entirely obvious. I think the code I came up with is pretty elegant ;] The final part of of the code that makes use of the parsed data is kept very similar to the shell code on purpose, even though it could be written a bit more idiomatically. --- man/check-os-release.py | 28 ++++++++++++++++++++++++++++ man/os-release.xml | 8 ++++++++ 2 files changed, 36 insertions(+) create mode 100644 man/check-os-release.py diff --git a/man/check-os-release.py b/man/check-os-release.py new file mode 100644 index 0000000000..f6d23c8c46 --- /dev/null +++ b/man/check-os-release.py @@ -0,0 +1,28 @@ +#!/usr/bin/python + +import ast +import re + +def read_os_release(): + try: + f = open('/etc/os-release') + except FileNotFoundError: + f = open('/usr/lib/os-release') + + for line_number, line in enumerate(f): + if m := re.match(r'([A-Z][A-Z_0-9]+)=(.*)', line): + name, val = m.groups() + if val and val[0] in '"\'': + val = ast.literal_eval(val) + yield name, val + else: + print(f'Warning: bad line {line_number}: {line}', file=sys.stderr) + +os_release = dict(read_os_release()) + +pretty_name = os_release.get('PRETTY_NAME', 'Linux') +print(f'Running on {pretty_name}') + +if (os_release.get('ID', 'linux') == 'debian' or + os_release.get('ID_LIKE', None) == 'debian'): + print('Looks like Debian!') diff --git a/man/os-release.xml b/man/os-release.xml index 36e5bed62e..a00b8a5264 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -419,6 +419,14 @@ VARIANT_ID=workstation + + + Reading <filename>os-release</filename> in + <citerefentry><refentrytitle>python</refentrytitle><manvolnum>1</manvolnum></citerefentry> + + + + From 8fd67ab5a38822475c79f3d2d7864585a7898f59 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Thu, 20 May 2021 20:37:55 +0200 Subject: [PATCH 4/6] man: reword description of BUILD_ID in os-release Our description was pretty hard to parse. Let's replace it with a description loosely based on a fairly clear description written by a distro that actually uses BUILD_ID: https://developer.rigado.com/docsets/Working-with-the-Rigado-Vesta-Gateway/latest/production/versioning-images.html#the-rigos-scheme. --- man/os-release.xml | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/man/os-release.xml b/man/os-release.xml index a00b8a5264..52323df6c7 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -224,12 +224,13 @@ BUILD_ID= - A string uniquely identifying the system image used as the origin for a distribution - (it is not updated with system updates). The field can be identical between different - VERSION_IDs as BUILD_ID is an only a unique identifier to a - specific version. Distributions that release each update as a new version would only need to use - VERSION_ID as each build is already distinct based on the - VERSION_ID. This field is optional. + A string uniquely identifying the system image originally used as the installation + base. In most cases, VERSION_ID or + IMAGE_ID+IMAGE_VERSION are updated when the entire system + image is replaced during an update. BUILD_ID may be used in distributions where + the original installation image version is important: VERSION_ID would change + during incremental system updates, but BUILD_ID would not. This field is + optional. Examples: BUILD_ID="2013-03-20.3", BUILD_ID=201303203. @@ -261,6 +262,13 @@ + + To summarize: if the image updates are built and shipped as comprehensive units, + IMAGE_ID+IMAGE_VERSION is the best fit. Otherwise, if updates + eventually completely replace previously installed contents, as in a typical binary distribution, + VERSION_ID should be used to identify major releases of the operating system. + BUILD_ID may be used instead or in addition to VERSION_ID when + the original system image version is important. From c0527e1f951a9fafb6009445c365bc41f5992817 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Fri, 21 May 2021 11:11:01 +0200 Subject: [PATCH 5/6] man: say that initrd-release is like os-release --- man/os-release.xml | 15 +++++++++++++++ man/rules/meson.build | 2 +- 2 files changed, 16 insertions(+), 1 deletion(-) diff --git a/man/os-release.xml b/man/os-release.xml index 52323df6c7..fb24eda182 100644 --- a/man/os-release.xml +++ b/man/os-release.xml @@ -16,12 +16,14 @@ os-release + initrd-release Operating system identification /etc/os-release /usr/lib/os-release + /etc/initrd-release @@ -79,6 +81,19 @@ For a longer rationale for os-release please refer to the Announcement of /etc/os-release. + + + <filename>/etc/initrd-release</filename> + + In the initrd, + /etc/initrd-release plays the same role as os-release in the + main system. Additionally, the presence of that file means that the system is in the initrd phase. + /etc/os-release should be symlinked to /etc/initrd-release + (or vice versa), so programs that only look for /etc/os-release (as described + above) work correctly. The rest of this document that talks about os-release + should be understood to apply to initrd-release too. + diff --git a/man/rules/meson.build b/man/rules/meson.build index 05b087db3e..1cfb54723a 100644 --- a/man/rules/meson.build +++ b/man/rules/meson.build @@ -61,7 +61,7 @@ manpages = [ ['org.freedesktop.resolve1', '5', [], 'ENABLE_RESOLVE'], ['org.freedesktop.systemd1', '5', [], ''], ['org.freedesktop.timedate1', '5', [], 'ENABLE_TIMEDATED'], - ['os-release', '5', [], ''], + ['os-release', '5', ['initrd-release'], ''], ['pam_systemd', '8', [], 'HAVE_PAM'], ['pam_systemd_home', '8', [], 'ENABLE_PAM_HOME'], ['portablectl', '1', [], 'ENABLE_PORTABLED'], From 412339835ebc015bcb9c01f2e7d9f4eafc914a8e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Zbigniew=20J=C4=99drzejewski-Szmek?= Date: Fri, 21 May 2021 15:02:23 +0200 Subject: [PATCH 6/6] man/check-os-release.py: strip trailing whitespace The shell parser would do that, so so should we. --- man/check-os-release.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/man/check-os-release.py b/man/check-os-release.py index f6d23c8c46..069ca74b20 100644 --- a/man/check-os-release.py +++ b/man/check-os-release.py @@ -10,7 +10,7 @@ def read_os_release(): f = open('/usr/lib/os-release') for line_number, line in enumerate(f): - if m := re.match(r'([A-Z][A-Z_0-9]+)=(.*)', line): + if m := re.match(r'([A-Z][A-Z_0-9]+)=(.*?)\s*$', line): name, val = m.groups() if val and val[0] in '"\'': val = ast.literal_eval(val)