0006-FSDG-man-Use-FSDG-operating-systems-as-examples.patch 11 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249
  1. From 35af892f1dffbb0daa9aa721f908f7c38b064ebe Mon Sep 17 00:00:00 2001
  2. From: Luke Shumaker <lukeshu@parabola.nu>
  3. Date: Wed, 25 May 2016 12:32:21 -0400
  4. Subject: [PATCH 6/7] FSDG: man/: Use FSDG operating systems as examples
  5. ---
  6. man/os-release.xml | 49 +++++++++++++++++++++--------------------
  7. man/systemd-nspawn.xml | 50 +++++++++++++++++++++++-------------------
  8. 2 files changed, 52 insertions(+), 47 deletions(-)
  9. diff --git a/man/os-release.xml b/man/os-release.xml
  10. index 272258b4e1..6cea40cb99 100644
  11. --- a/man/os-release.xml
  12. +++ b/man/os-release.xml
  13. @@ -99,7 +99,7 @@
  14. without a version component, and suitable for presentation to
  15. the user. If not set, defaults to
  16. <literal>NAME=GNU/Linux</literal>. Example:
  17. - <literal>NAME=Fedora</literal> or <literal>NAME="Debian
  18. + <literal>NAME=BLAG</literal> or <literal>NAME="gNewSense
  19. GNU/Linux"</literal>.</para></listitem>
  20. </varlistentry>
  21. @@ -110,8 +110,8 @@
  22. version, excluding any OS name information, possibly including
  23. a release code name, and suitable for presentation to the
  24. user. This field is optional. Example:
  25. - <literal>VERSION=17</literal> or <literal>VERSION="17 (Beefy
  26. - Miracle)"</literal>.</para></listitem>
  27. + <literal>VERSION=210k</literal> or <literal>VERSION="210k
  28. + (Spartakus)"</literal>.</para></listitem>
  29. </varlistentry>
  30. <varlistentry>
  31. @@ -123,8 +123,8 @@
  32. suitable for processing by scripts or usage in generated
  33. filenames. If not set, defaults to
  34. <literal>ID=gnu-linux</literal>. Example:
  35. - <literal>ID=fedora</literal> or
  36. - <literal>ID=debian</literal>.</para></listitem>
  37. + <literal>ID=blag</literal> or
  38. + <literal>ID=gnewsense</literal>.</para></listitem>
  39. </varlistentry>
  40. <varlistentry>
  41. @@ -145,9 +145,9 @@
  42. should be listed in order of how closely the local operating
  43. system relates to the listed ones, starting with the closest.
  44. This field is optional. Example: for an operating system with
  45. - <literal>ID=centos</literal>, an assignment of
  46. + <literal>ID=blag</literal>, an assignment of
  47. <literal>ID_LIKE="rhel fedora"</literal> would be appropriate.
  48. - For an operating system with <literal>ID=ubuntu</literal>, an
  49. + For an operating system with <literal>ID=gnewsense</literal>, an
  50. assignment of <literal>ID_LIKE=debian</literal> is
  51. appropriate.</para></listitem>
  52. </varlistentry>
  53. @@ -176,8 +176,8 @@
  54. identifying the operating system version, excluding any OS
  55. name information or release code name, and suitable for
  56. processing by scripts or usage in generated filenames. This
  57. - field is optional. Example: <literal>VERSION_ID=17</literal>
  58. - or <literal>VERSION_ID=11.04</literal>.</para></listitem>
  59. + field is optional. Example: <literal>VERSION_ID=210k</literal>
  60. + or <literal>VERSION_ID=7.0</literal>.</para></listitem>
  61. </varlistentry>
  62. <varlistentry>
  63. @@ -188,8 +188,8 @@
  64. a release code name or OS version of some kind, as suitable.
  65. If not set, defaults to
  66. <literal>PRETTY_NAME="GNU/Linux"</literal>. Example:
  67. - <literal>PRETTY_NAME="Fedora 17 (Beefy
  68. - Miracle)"</literal>.</para></listitem>
  69. + <literal>PRETTY_NAME="BLAG 210k
  70. + (Spartakus)"</literal>.</para></listitem>
  71. </varlistentry>
  72. <varlistentry>
  73. @@ -212,7 +212,7 @@
  74. <ulink url="http://scap.nist.gov/specifications/cpe/">Common
  75. Platform Enumeration Specification</ulink> as proposed by the
  76. NIST. This field is optional. Example:
  77. - <literal>CPE_NAME="cpe:/o:fedoraproject:fedora:17"</literal>
  78. + <literal>CPE_NAME="cpe:/o:blagblagblag:blag:210k"</literal>
  79. </para></listitem>
  80. </varlistentry>
  81. @@ -247,8 +247,8 @@
  82. one URL shall be listed in each setting. If multiple resources
  83. need to be referenced, it is recommended to provide an online
  84. landing page linking all available resources. Examples:
  85. - <literal>HOME_URL="https://fedoraproject.org/"</literal> and
  86. - <literal>BUG_REPORT_URL="https://bugzilla.redhat.com/"</literal></para></listitem>
  87. + <literal>HOME_URL="https://www.blagblagblag.org/"</literal> and
  88. + <literal>BUG_REPORT_URL="https://blag.fsf.org/"</literal></para></listitem>
  89. </varlistentry>
  90. <varlistentry>
  91. @@ -323,21 +323,22 @@
  92. recommended to prefix new fields with an OS specific
  93. name in order to avoid name clashes. Applications
  94. reading this file must ignore unknown fields. Example:
  95. - <literal>DEBIAN_BTS="debbugs://bugs.debian.org/"</literal></para>
  96. + <literal>DEBIAN_BTS="debbugs://bugs.gnewsense.org/"</literal></para>
  97. </refsect1>
  98. <refsect1>
  99. <title>Example</title>
  100. - <programlisting>NAME=Fedora
  101. -VERSION="17 (Beefy Miracle)"
  102. -ID=fedora
  103. -VERSION_ID=17
  104. -PRETTY_NAME="Fedora 17 (Beefy Miracle)"
  105. -ANSI_COLOR="0;34"
  106. -CPE_NAME="cpe:/o:fedoraproject:fedora:17"
  107. -HOME_URL="https://fedoraproject.org/"
  108. -BUG_REPORT_URL="https://bugzilla.redhat.com/"</programlisting>
  109. + <programlisting>NAME=Parabola
  110. +VERSION="rolling-release"
  111. +ID=parabola
  112. +ID_LIKE=arch
  113. +VERSION_ID=rolling-release
  114. +PRETTY_NAME="Parabola GNU/Linux-libre"
  115. +ANSI_COLOR="1;35"
  116. +CPE_NAME="cpe:/o:parabola:parabola:rolling-release"
  117. +HOME_URL="https://www.parabola.nu/"
  118. +BUG_REPORT_URL="https://labs.parabola.nu/"</programlisting>
  119. </refsect1>
  120. <refsect1>
  121. diff --git a/man/systemd-nspawn.xml b/man/systemd-nspawn.xml
  122. index 284c9b294b..7b3d211161 100644
  123. --- a/man/systemd-nspawn.xml
  124. +++ b/man/systemd-nspawn.xml
  125. @@ -1,7 +1,7 @@
  126. <?xml version='1.0'?> <!--*- Mode: nxml; nxml-child-indent: 2; indent-tabs-mode: nil -*-->
  127. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  128. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
  129. -<!ENTITY fedora_latest_version "28">
  130. +<!ENTITY blag_latest_version "140">
  131. <!ENTITY fedora_cloud_release "1.1">
  132. ]>
  133. @@ -1176,11 +1176,12 @@
  134. <refsect1>
  135. <title>Examples</title>
  136. +<!-- TODO: This example needs switched to an FSDG OS; but I'm not sure of a good machinectl-compatible image to use.
  137. <example>
  138. <title>Download a
  139. <ulink url="https://getfedora.org">Fedora</ulink> image and start a shell in it</title>
  140. - <programlisting># machinectl pull-raw --verify=no \
  141. + <programlisting># machinectl pull-raw -&2D;verify=no \
  142. https://download.fedoraproject.org/pub/fedora/linux/releases/&fedora_latest_version;/Cloud/x86_64/images/Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw.xz
  143. # systemd-nspawn -M Fedora-Cloud-Base-&fedora_latest_version;-&fedora_cloud_release;.x86_64.raw</programlisting>
  144. @@ -1188,31 +1189,32 @@
  145. <citerefentry><refentrytitle>machinectl</refentrytitle><manvolnum>1</manvolnum></citerefentry>
  146. and opens a shell in it.</para>
  147. </example>
  148. +-->
  149. <example>
  150. - <title>Build and boot a minimal Fedora distribution in a container</title>
  151. + <title>Build and boot a minimal BLAG distribution in a container</title>
  152. - <programlisting># dnf -y --releasever=&fedora_latest_version; --installroot=/var/lib/machines/f&fedora_latest_version; \
  153. - --disablerepo='*' --enablerepo=fedora --enablerepo=updates install \
  154. - systemd passwd dnf fedora-release vim-minimal
  155. -# systemd-nspawn -bD /var/lib/machines/f&fedora_latest_version;</programlisting>
  156. + <programlisting># dnf -y --releasever=&blag_latest_version;k --installroot=/var/lib/machines/blag&blag_latest_version; \
  157. + --disablerepo='*' --enablerepo=blag --enablerepo=updates install \
  158. + systemd passwd dnf blag-release vim-minimal
  159. +# systemd-nspawn -bD /var/lib/machines/blag&blag_latest_version;</programlisting>
  160. - <para>This installs a minimal Fedora distribution into the
  161. - directory <filename noindex='true'>/var/lib/machines/f&fedora_latest_version;</filename>
  162. + <para>This installs a minimal BLAG distribution into the
  163. + directory <filename noindex='true'>/var/lib/machines/blag&blag_latest_version;</filename>
  164. and then boots an OS in a namespace container in it. Because the installation
  165. is located underneath the standard <filename>/var/lib/machines/</filename>
  166. directory, it is also possible to start the machine using
  167. - <command>systemd-nspawn -M f&fedora_latest_version;</command>.</para>
  168. + <command>systemd-nspawn -M blag&blag_latest_version;</command>.</para>
  169. </example>
  170. <example>
  171. - <title>Spawn a shell in a container of a minimal Debian unstable distribution</title>
  172. + <title>Spawn a shell in a container of a minimal gNewSense Ucclia distribution</title>
  173. - <programlisting># debootstrap unstable ~/debian-tree/
  174. -# systemd-nspawn -D ~/debian-tree/</programlisting>
  175. + <programlisting># debootstrap ucclia ~/gnewsense-tree/
  176. +# systemd-nspawn -D ~/gnewsense-tree/</programlisting>
  177. - <para>This installs a minimal Debian unstable distribution into
  178. - the directory <filename>~/debian-tree/</filename> and then
  179. + <para>This installs a minimal gNewSense unstable distribution into
  180. + the directory <filename>~/gnewsense-tree/</filename> and then
  181. spawns a shell in a namespace container in it.</para>
  182. <para><command>debootstrap</command> supports
  183. @@ -1227,29 +1229,31 @@
  184. <example>
  185. <title>Boot a minimal
  186. - <ulink url="https://www.archlinux.org">Arch Linux</ulink> distribution in a container</title>
  187. + <ulink url="https://www.parabola.nu">Parabola GNU/Linux-libre</ulink> distribution in a container</title>
  188. - <programlisting># pacstrap -c -d ~/arch-tree/ base
  189. -# systemd-nspawn -bD ~/arch-tree/</programlisting>
  190. + <programlisting># pacstrap -c -d ~/parabola-tree/ base
  191. +# systemd-nspawn -bD ~/parabola-tree/</programlisting>
  192. - <para>This installs a minimal Arch Linux distribution into the
  193. - directory <filename>~/arch-tree/</filename> and then boots an OS
  194. + <para>This installs a minimal Parabola distribution into the
  195. + directory <filename>~/parabola-tree/</filename> and then boots an OS
  196. in a namespace container in it.</para>
  197. </example>
  198. +<!-- TODO: This example needs switched to an FSDG OS
  199. <example>
  200. <title>Install the
  201. <ulink url="https://software.opensuse.org/distributions/tumbleweed">OpenSUSE Tumbleweed</ulink>
  202. rolling distribution</title>
  203. - <programlisting># zypper --root=/var/lib/machines/tumbleweed ar -c \
  204. + <programlisting># zypper -&2Droot=/var/lib/machines/tumbleweed ar -c \
  205. https://download.opensuse.org/tumbleweed/repo/oss tumbleweed
  206. -# zypper --root=/var/lib/machines/tumbleweed refresh
  207. -# zypper --root=/var/lib/machines/tumbleweed install --no-recommends \
  208. +# zypper -&2Droot=/var/lib/machines/tumbleweed refresh
  209. +# zypper -&2Droot=/var/lib/machines/tumbleweed install -&2Dno-recommends \
  210. systemd shadow zypper openSUSE-release vim
  211. # systemd-nspawn -M tumbleweed passwd root
  212. # systemd-nspawn -M tumbleweed -b</programlisting>
  213. </example>
  214. +-->
  215. <example>
  216. <title>Boot into an ephemeral snapshot of the host system</title>
  217. --
  218. 2.18.0