networkd-wait-online: add timeout

[elogind.git] / man / os-release.xml

diff --git a/man/os-release.xml b/man/os-release.xml
index 4e02f800b63d19cc9c754eb5c35df7a258796596..4fa41e7297f3caeed7e253d081e2b23e267b06db 100644 (file)
--- a/man/os-release.xml
+++ b/man/os-release.xml
@@ -68,17 +68,16 @@
                 (this means variable expansion is explicitly not
                 supported), allowing applications to read the file
                 without implementing a shell compatible execution
-                engine. Variable assignment values should be enclosed
-                in double or single quotes if they include spaces,
+                engine. Variable assignment values must be enclosed in
+                double or single quotes if they include spaces,
                 semicolons or other special characters outside of A-Z,
-                a-z, 0-9. All strings should be in UTF-8 format, and
-                non-printable characters should not be used. If double
-                or single quotes or backslashes are to be used within
-                variable assignments, they should be escaped with
-                backslashes, following shell style. It is not
-                supported to concatenate multiple individually quoted
-                strings. Lines beginning with "#" shall be ignored as
-                comments.</para>
+                a-z, 0-9.  Shell special characters ("$", quotes,
+                backslash, backtick) must be escaped with backslashes,
+                following shell style.  All strings should be in UTF-8
+                format, and non-printable characters should not be used.
+                It is not supported to concatenate multiple individually
+                quoted strings. Lines beginning with "#" shall be
+                ignored as comments.</para>
 
                 <para>The file <filename>/etc/os-release</filename>
                 takes precedence over
@@ -90,11 +89,15 @@
                 files at the same
                 time. <filename>/usr/lib/os-release</filename> is the
                 recommended place to store OS release information as
-                part of vendor trees. Frequently,
-                <filename>/etc/os-release</filename> is simply a
-                symlink to <filename>/usr/lib/os-release</filename>,
+                part of vendor trees.
+                <filename>/etc/os-release</filename> should be a
+                relative symlink to
+                <filename>/usr/lib/os-release</filename>,
                 to provide compatibility with applications only
-                looking at <filename>/etc</filename>.</para>
+                looking at <filename>/etc</filename>. A relative
+                symlink instead of an absolute symlink is
+                necessary to avoid breaking the link in a chroot or
+                initrd environment such as dracut.</para>
 
                 <para><filename>os-release</filename> contains data
                 that is defined by the operating system vendor and
@@ -274,6 +277,7 @@
                                 <term><varname>HOME_URL=</varname></term>
                                 <term><varname>SUPPORT_URL=</varname></term>
                                 <term><varname>BUG_REPORT_URL=</varname></term>
+                                <term><varname>PRIVACY_POLICY_URL=</varname></term>
 
                                 <listitem><para>Links to resources on
                                 the Internet related the operating
@@ -293,15 +297,19 @@
                                 page for the operating system, if
                                 there is any. This is primarily
                                 intended for operating systems that
-                                rely on community QA. These settings
+                                rely on community QA.
+                                <varname>PRIVACY_POLICY_URL=</varname>
+                                should refer to the main privacy policy
+                                page for the operation 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",
-                                and "Report a Bug". The values should
-                                be in <ulink
+                                "Report a Bug", or "Privacy Policy". The
+                                values should be in <ulink
                                 url="https://tools.ietf.org/html/rfc3986">RFC3986
                                 format</ulink>, and should be
                                 <literal>http:</literal> or