Merge f4429e9753 into bf39626d61

doc-migration/db2rst.py

@@ -44,7 +44,7 @@ WRITE_UNUSED_LABELS = False
 
 # The Files have sections that are used as includes in other files
 FILES_USED_FOR_INCLUDES = ['sd_journal_get_data.xml', 'standard-options.xml',
-                           'user-system-options.xml', 'common-variables.xml', 'standard-conf.xml',
+                           'user-system-options.xml', 'common-variables.xml','standard-conf.xml',
                            'libsystemd-pkgconfig.xml', 'threads-aware.xml']
 
 # to avoid dupliate error reports
@@ -320,7 +320,6 @@ def refsynopsisdiv(el):
     s += _join_children(el, ', ')
     return s
 
-
 def refname(el):
     _has_only_text(el)
     return "%s" % el.text
@@ -434,7 +433,6 @@ def constant(el):
 
 filename = command
 
-
 def optional(el):
     return "[%s]" % _concat(el).strip()
 
@@ -692,15 +690,12 @@ def screen(el):
 def synopsis(el):
     return _indent(el, 3, "::\n\n", False) + "\n\n"
 
-
 def funcsynopsis(el):
     return _concat(el)
 
-
 def funcsynopsisinfo(el):
     return "``%s``" % _concat(el)
 
-
 def funcprototype(el):
     funcdef = ''.join(el.find('.//funcdef').itertext())
     params = el.findall('.//paramdef')
@@ -711,55 +706,19 @@ def funcprototype(el):
     s += ");"
     return s
 
-
 def paramdef(el):
     return el
 
-
 def funcdef(el):
     return el
 
-
 def function(el):
     return _concat(el).strip()
 
-
 def parameter(el):
     return el
 
 
-def table(el):
-    title = _concat(el.find('title'))
-    headers = el.findall('.//thead/row/entry')
-    rows = el.findall('.//tbody/row')
-
-    # Collect header names
-    header_texts = [_concat(header) for header in headers]
-
-    # Collect row data
-    row_data = []
-    for row in rows:
-        entries = row.findall('entry')
-        row_data.append([_concat(entry) for entry in entries])
-
-    # Create the table in reST list-table format
-    rst_table = []
-    rst_table.append(f".. list-table:: {title}")
-    rst_table.append("   :header-rows: 1")
-    rst_table.append("")
-
-    # Add header row
-    header_line = "   * - " + "\n     - ".join(header_texts)
-    rst_table.append(header_line)
-
-    # Add rows
-    for row in row_data:
-        row_line = "   * - " + "\n     - ".join(row)
-        rst_table.append(row_line)
-
-    return '\n'.join(rst_table)
-
-
 def userinput(el):
     return _indent(el, 3, "\n\n")
 

doc-migration/source/docs/repart.d.rst

@@ -1,862 +0,0 @@
-.. SPDX-License-Identifier: LGPL-2.1-or-later:
-
-:title: repart.d
-
-:manvolnum: 5
-
-.. _repart.d(5):
-
-===========
-repart.d(5)
-===========
-
-.. only:: html
-
-   repart.d — Partition Definition Files for Automatic Boot-Time Repartitioning
-   ############################################################################
-
-   Synopsis
-   ########
-
-``/etc/repart.d/\*.conf``
-``/run/repart.d/\*.conf``
-``/usr/local/lib/repart.d/\*.conf``
-``/usr/lib/repart.d/\*.conf``
-
-Description
-===========
-
-``repart.d/\*.conf`` files describe basic properties of partitions of block
-devices of the local system. They may be used to declare types, names and sizes of partitions that shall
-exist. The
-:ref:`systemd-repart(8)`
-service reads these files and attempts to add new partitions currently missing and enlarge existing
-partitions according to these definitions. Operation is generally incremental, i.e. when applied, what
-exists already is left intact, and partitions are never shrunk, moved or deleted.
-
-These definition files are useful for implementing operating system images that are prepared and
-delivered with minimally sized images (for example lacking any state or swap partitions), and which on
-first boot automatically take possession of any remaining disk space following a few basic rules.
-
-Currently, support for partition definition files is only implemented for GPT partition
-tables.
-
-Partition files are generally matched against any partitions already existing on disk in a simple
-algorithm: the partition files are sorted by their filename (ignoring the directory prefix), and then
-compared in order against existing partitions matching the same partition type UUID. Specifically, the
-first existing partition with a specific partition type UUID is assigned the first definition file with
-the same partition type UUID, and the second existing partition with a specific type UUID the second
-partition file with the same type UUID, and so on. Any left-over partition files that have no matching
-existing partition are assumed to define new partition that shall be created. Such partitions are
-appended to the end of the partition table, in the order defined by their names utilizing the first
-partition slot greater than the highest slot number currently in use. Any existing partitions that have
-no matching partition file are left as they are.
-
-Note that these definitions may only be used to create and initialize new partitions or to grow
-existing ones. In the latter case it will not grow the contained files systems however; separate
-mechanisms, such as
-:ref:`systemd-growfs(8)` may be
-used to grow the file systems inside of these partitions. Partitions may also be marked for automatic
-growing via the ``GrowFileSystem=`` setting, in which case the file system is grown on
-first mount by tools that respect this flag. See below for details.
-
-[Partition] Section Options
-===========================
-
-``Type=``
----------
-
-The GPT partition type UUID to match. This may be a GPT partition type UUID such as
-``4f68bce3-e8cd-4db1-96e7-fbcaf984b709``, or an identifier.
-Architecture specific partition types can use one of these architecture identifiers:
-``alpha``, ``arc``, ``arm`` (32-bit),
-``arm64`` (64-bit, aka aarch64), ``ia64``,
-``loongarch64``, ``mips-le``, ``mips64-le``,
-``parisc``, ``ppc``, ``ppc64``,
-``ppc64-le``, ``riscv32``, ``riscv64``,
-``s390``, ``s390x``, ``tilegx``,
-``x86`` (32-bit, aka i386) and ``x86-64`` (64-bit, aka amd64).
-
-The supported identifiers are:
-
-.. list-table:: GPT partition type identifiers
-   :header-rows: 1
-   * - Identifier
-     - Explanation
-   * - ``esp``
-     - EFI System Partition
-   * - ``xbootldr``
-     - Extended Boot Loader Partition
-   * - ``swap``
-     - Swap partition
-   * - ``home``
-     - Home (``/home/``) partition
-   * - ``srv``
-     - Server data (``/srv/``) partition
-   * - ``var``
-     - Variable data (``/var/``) partition
-   * - ``tmp``
-     - Temporary data (``/var/tmp/``) partition
-   * - ``linux-generic``
-     - Generic Linux file system partition
-   * - ``root``
-     - Root file system partition type appropriate for the local architecture (an alias for an architecture root file system partition type listed below, e.g. ``root-x86-64``)
-   * - ``root-verity``
-     - Verity data for the root file system partition for the local architecture
-   * - ``root-verity-sig``
-     - Verity signature data for the root file system partition for the local architecture
-   * - ``root-secondary``
-     - Root file system partition of the secondary architecture of the local architecture (usually the matching 32-bit architecture for the local 64-bit architecture)
-   * - ``root-secondary-verity``
-     - Verity data for the root file system partition of the secondary architecture
-   * - ``root-secondary-verity-sig``
-     - Verity signature data for the root file system partition of the secondary architecture
-   * - ``root-{arch}``
-     - Root file system partition of the given architecture (such as ``root-x86-64`` or ``root-riscv64``)
-   * - ``root-{arch}-verity``
-     - Verity data for the root file system partition of the given architecture
-   * - ``root-{arch}-verity-sig``
-     - Verity signature data for the root file system partition of the given architecture
-   * - ``usr``
-     - ``/usr/`` file system partition type appropriate for the local architecture (an alias for an architecture ``/usr/`` file system partition type listed below, e.g. ``usr-x86-64``)
-   * - ``usr-verity``
-     - Verity data for the ``/usr/`` file system partition for the local architecture
-   * - ``usr-verity-sig``
-     - Verity signature data for the ``/usr/`` file system partition for the local architecture
-   * - ``usr-secondary``
-     - ``/usr/`` file system partition of the secondary architecture of the local architecture (usually the matching 32-bit architecture for the local 64-bit architecture)
-   * - ``usr-secondary-verity``
-     - Verity data for the ``/usr/`` file system partition of the secondary architecture
-   * - ``usr-secondary-verity-sig``
-     - Verity signature data for the ``/usr/`` file system partition of the secondary architecture
-   * - ``usr-{arch}``
-     - ``/usr/`` file system partition of the given architecture
-   * - ``usr-{arch}-verity``
-     - Verity data for the ``/usr/`` file system partition of the given architecture
-   * - ``usr-{arch}-verity-sig``
-     - Verity signature data for the ``/usr/`` file system partition of the given architecture
-This setting defaults to ``linux-generic``.
-
-Most of the partition type UUIDs listed above are defined in the `Discoverable Partitions
-Specification <https://uapi-group.org/specifications/specs/discoverable_partitions_specification>`_.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``Label=``
-----------
-
-The textual label to assign to the partition if none is assigned yet. Note that this
-setting is not used for matching. It is also not used when a label is already set for an existing
-partition. It is thus only used when a partition is newly created or when an existing one had a no
-label set (that is: an empty label). If not specified a label derived from the partition type is
-automatically used. Simple specifier expansion is supported, see below.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``UUID=``
----------
-
-The UUID to assign to the partition if none is assigned yet. Note that this
-setting is not used for matching. It is also not used when a UUID is already set for an existing
-partition. It is thus only used when a partition is newly created or when an existing one had a
-all-zero UUID set. If set to "null", the UUID is set to all zeroes. If not specified
-a UUID derived from the partition type is automatically used.
-
-.. only:: html
-
-   .. versionadded:: 246
-
-``Priority=``
--------------
-
-A numeric priority to assign to this partition, in the range -2147483648…2147483647,
-with smaller values indicating higher priority, and higher values indicating smaller priority. This
-priority is used in case the configured size constraints on the defined partitions do not permit
-fitting all partitions onto the available disk space. If the partitions do not fit, the highest
-numeric partition priority of all defined partitions is determined, and all defined partitions with
-this priority are removed from the list of new partitions to create (which may be multiple, if the
-same priority is used for multiple partitions). The fitting algorithm is then tried again. If the
-partitions still do not fit, the now highest numeric partition priority is determined, and the
-matching partitions removed too, and so on. Partitions of a priority of 0 or lower are never
-removed. If all partitions with a priority above 0 are removed and the partitions still do not fit on
-the device the operation fails. Note that this priority has no effect on ordering partitions, for
-that use the alphabetical order of the filenames of the partition definition files. Defaults to
-0.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``Weight=``
------------
-
-A numeric weight to assign to this partition in the range 0…1000000. Available disk
-space is assigned the defined partitions according to their relative weights (subject to the size
-constraints configured with ``SizeMinBytes=``, ``SizeMaxBytes=``), so
-that a partition with weight 2000 gets double the space as one with weight 1000, and a partition with
-weight 333 a third of that. Defaults to 1000.
-
-The ``Weight=`` setting is used to distribute available disk space in an
-"elastic" fashion, based on the disk size and existing partitions. If a partition shall have a fixed
-size use both ``SizeMinBytes=`` and ``SizeMaxBytes=`` with the same
-value in order to fixate the size to one value, in which case the weight has no
-effect.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``PaddingWeight=``
-------------------
-
-Similar to ``Weight=``, but sets a weight for the free space after the
-partition (the "padding"). When distributing available space the weights of all partitions and all
-defined padding is summed, and then each partition and padding gets the fraction defined by its
-weight. Defaults to 0, i.e. by default no padding is applied.
-
-Padding is useful if empty space shall be left for later additions or a safety margin at the
-end of the device or between partitions.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``SizeMinBytes=, SizeMaxBytes=``
---------------------------------
-
-Specifies minimum and maximum size constraints in bytes. Takes the usual K, M, G, T,
-…  suffixes (to the base of 1024). If ``SizeMinBytes=`` is specified the partition is
-created at or grown to at least the specified size. If ``SizeMaxBytes=`` is specified
-the partition is created at or grown to at most the specified size. The precise size is determined
-through the weight value configured with ``Weight=``, see above. When
-``SizeMinBytes=`` is set equal to ``SizeMaxBytes=`` the configured
-weight has no effect as the partition is explicitly sized to the specified fixed value. Note that
-partitions are never created smaller than 4096 bytes, and since partitions are never shrunk the
-previous size of the partition (in case the partition already exists) is also enforced as lower bound
-for the new size. The values should be specified as multiples of 4096 bytes, and are rounded upwards
-(in case of ``SizeMinBytes=``) or downwards (in case of
-``SizeMaxBytes=``) otherwise. If the backing device does not provide enough space to
-fulfill the constraints placing the partition will fail. For partitions that shall be created,
-depending on the setting of ``Priority=`` (see above) the partition might be dropped
-and the placing algorithm restarted. By default a minimum size constraint of 10M and no maximum size
-constraint is set.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``PaddingMinBytes=, PaddingMaxBytes=``
---------------------------------------
-
-Specifies minimum and maximum size constraints in bytes for the free space after the
-partition (the "padding"). Semantics are similar to ``SizeMinBytes=`` and
-``SizeMaxBytes=``, except that unlike partition sizes free space can be shrunk and can
-be as small as zero. By default no size constraints on padding are set, so that only
-``PaddingWeight=`` determines the size of the padding applied.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``CopyBlocks=``
----------------
-
-Takes a path to a regular file, block device node, char device node or directory, or
-the special value "auto". If specified and the partition is newly created, the data
-from the specified path is written to the newly created partition, on the block level. If a directory
-is specified, the backing block device of the file system the directory is on is determined, and the
-data read directly from that. This option is useful to efficiently replicate existing file systems
-onto new partitions on the block level — for example to build a simple OS installer or an OS image
-builder. Specify ``/dev/urandom`` as value to initialize a partition with random
-data.
-
-If the special value "auto" is specified, the source to copy from is
-automatically picked up from the running system (or the image specified with
-``--image=`` — if used). A partition that matches both the configured partition type (as
-declared with ``Type=`` described above), and the currently mounted directory
-appropriate for that partition type is determined. For example, if the partition type is set to
-"root" the partition backing the root directory (``/``) is used as
-source to copy from — if its partition type is set to "root" as well. If the
-declared type is "usr" the partition backing ``/usr/`` is used as
-source to copy blocks from — if its partition type is set to "usr" too. The logic is
-capable of automatically tracking down the backing partitions for encrypted and Verity-enabled
-volumes. "CopyBlocks=auto" is useful for implementing "self-replicating" systems,
-i.e. systems that are their own installer.
-
-The file specified here must have a size that is a multiple of the basic block size 512 and not
-be empty. If this option is used, the size allocation algorithm is slightly altered: the partition is
-created at least as big as required to fit the data in, i.e. the data size is an additional minimum
-size value taken into consideration for the allocation algorithm, similar to and in addition to the
-``SizeMin=`` value configured above.
-
-This option has no effect if the partition it is declared for already exists, i.e. existing
-data is never overwritten. Note that the data is copied in before the partition table is updated,
-i.e. before the partition actually is persistently created. This provides robustness: it is
-guaranteed that the partition either doesn't exist or exists fully populated; it is not possible that
-the partition exists but is not or only partially populated.
-
-This option cannot be combined with ``Format=`` or
-``CopyFiles=``.
-
-.. only:: html
-
-   .. versionadded:: 246
-
-``Format=``
------------
-
-Takes a file system name, such as "ext4", "btrfs",
-"xfs", "vfat", "erofs",
-"squashfs" or the special value "swap". If specified and the partition
-is newly created it is formatted with the specified file system (or as swap device). The file system
-UUID and label are automatically derived from the partition UUID and label. If this option is used,
-the size allocation algorithm is slightly altered: the partition is created at least as big as
-required for the minimal file system of the specified type (or 4KiB if the minimal size is not
-known).
-
-This option has no effect if the partition already exists.
-
-Similarly to the behaviour of ``CopyBlocks=``, the file system is formatted
-before the partition is created, ensuring that the partition only ever exists with a fully
-initialized file system.
-
-This option cannot be combined with ``CopyBlocks=``.
-
-.. only:: html
-
-   .. versionadded:: 247
-
-``CopyFiles=``
---------------
-
-Takes a pair of colon separated absolute file system paths. The first path refers to
-a source file or directory on the host, the second path refers to a target in the file system of the
-newly created partition and formatted file system. This setting may be used to copy files or
-directories from the host into the file system that is created due to the ``Format=``
-option. If ``CopyFiles=`` is used without ``Format=`` specified
-explicitly, "Format=" with a suitable default is implied (currently
-"vfat" for "ESP" and "XBOOTLDR" partitions, and
-"ext4" otherwise, but this may change in the future). This option may be used
-multiple times to copy multiple files or directories from host into the newly formatted file system.
-The colon and second path may be omitted in which case the source path is also used as the target
-path (relative to the root of the newly created file system). If the source path refers to a
-directory it is copied recursively.
-
-This option has no effect if the partition already exists: it cannot be used to copy additional
-files into an existing partition, it may only be used to populate a file system created anew.
-
-The copy operation is executed before the file system is registered in the partition table,
-thus ensuring that a file system populated this way only ever exists fully initialized.
-
-Note that ``CopyFiles=`` will skip copying files that aren't supported by the
-target filesystem (e.g symlinks, fifos, sockets and devices on vfat). When an unsupported file type
-is encountered, ``systemd-repart`` will skip copying this file and write a log message
-about it.
-
-Note that ``systemd-repart`` does not change the UIDs/GIDs of any copied files
-and directories. When running ``systemd-repart`` as an unprivileged user to build an
-image of files and directories owned by the same user, you can run ``systemd-repart``
-in a user namespace with the current user mapped to the root user to make sure the files and
-directories in the image are owned by the root user.
-
-Note that when populating XFS filesystems with ``systemd-repart`` and loop
-devices are not available, populating XFS filesystems with files containing spaces, tabs or newlines
-might fail on old versions of
-:man-pages:`mkfs.xfs(8)`
-due to limitations of its protofile format.
-
-Note that when populating XFS filesystems with ``systemd-repart`` and loop
-devices are not available, extended attributes will not be copied into generated XFS filesystems
-due to limitations :man-pages:`mkfs.xfs(8)`'s
-protofile format.
-
-This option cannot be combined with ``CopyBlocks=``.
-
-When
-:ref:`systemd-repart(8)` is
-invoked with the ``--copy-source=`` command line switch the file paths are taken
-relative to the specified directory. If ``--copy-source=`` is not used, but the
-``--image=`` or ``--root=`` switches are used, the source paths are taken
-relative to the specified root directory or disk image root.
-
-.. only:: html
-
-   .. versionadded:: 247
-
-``ExcludeFiles=, ExcludeFilesTarget=``
---------------------------------------
-
-Takes an absolute file system path referring to a source file or directory on the
-host. This setting may be used to exclude files or directories from the host from being copied into
-the file system when ``CopyFiles=`` is used. This option may be used multiple times to
-exclude multiple files or directories from host from being copied into the newly formatted file
-system.
-
-If the path is a directory and ends with "/", only the directory's
-contents are excluded but not the directory itself. If the path is a directory and does not end with
-"/", both the directory and its contents are excluded.
-
-``ExcludeFilesTarget=`` is like ``ExcludeFiles=`` except that
-instead of excluding the path on the host from being copied into the partition, we exclude any files
-and directories from being copied into the given path in the partition.
-
-When
-:ref:`systemd-repart(8)`
-is invoked with the ``--image=`` or ``--root=`` command line switches the
-paths specified are taken relative to the specified root directory or disk image root.
-
-.. only:: html
-
-   .. versionadded:: 254
-
-``MakeDirectories=``
---------------------
-
-Takes one or more absolute paths, separated by whitespace, each declaring a directory
-to create within the new file system. Behaviour is similar to ``CopyFiles=``, but
-instead of copying in a set of files this just creates the specified directories with the default
-mode of 0755 owned by the root user and group, plus all their parent directories (with the same
-ownership and access mode). To configure directories with different ownership or access mode, use
-``CopyFiles=`` and specify a source tree to copy containing appropriately
-owned/configured directories. This option may be used more than once to create multiple
-directories. When ``CopyFiles=`` and ``MakeDirectories=`` are used
-together the former is applied first. If a directory listed already exists no operation is executed
-(in particular, the ownership/access mode of the directories is left as is).
-
-The primary use case for this option is to create a minimal set of directories that may be
-mounted over by other partitions contained in the same disk image. For example, a disk image where
-the root file system is formatted at first boot might want to automatically pre-create
-``/usr/`` in it this way, so that the "usr" partition may
-over-mount it.
-
-Consider using
-:ref:`systemd-tmpfiles(8)`
-with its ``--image=`` option to pre-create other, more complex directory hierarchies (as
-well as other inodes) with fine-grained control of ownership, access modes and other file
-attributes.
-
-.. only:: html
-
-   .. versionadded:: 249
-
-``Subvolumes=``
----------------
-
-Takes one or more absolute paths, separated by whitespace, each declaring a directory
-that should be a subvolume within the new file system. This option may be used more than once to
-specify multiple directories. Note that this setting does not create the directories themselves, that
-can be configured with ``MakeDirectories=`` and ``CopyFiles=``.
-
-Note that this option only takes effect if the target filesystem supports subvolumes, such as
-"btrfs".
-
-Note that due to limitations of "mkfs.btrfs", this option is only supported
-when running with ``--offline=no``.
-
-.. only:: html
-
-   .. versionadded:: 255
-
-``DefaultSubvolume=``
----------------------
-
-Takes an absolute path specifying the default subvolume within the new filesystem.
-Note that this setting does not create the subvolume itself, that can be configured with
-``Subvolumes=``.
-
-Note that this option only takes effect if the target filesystem supports subvolumes, such as
-"btrfs".
-
-Note that due to limitations of "mkfs.btrfs", this option is only supported
-when running with ``--offline=no``.
-
-.. only:: html
-
-   .. versionadded:: 256
-
-``Encrypt=``
-------------
-
-Takes one of "off", "key-file",
-"tpm2" and "key-file+tpm2" (alternatively, also accepts a boolean
-value, which is mapped to "off" when false, and "key-file" when
-true). Defaults to "off". If not "off" the partition will be
-formatted with a LUKS2 superblock, before the blocks configured with ``CopyBlocks=``
-are copied in or the file system configured with ``Format=`` is created.
-
-The LUKS2 UUID is automatically derived from the partition UUID in a stable fashion. If
-"key-file" or "key-file+tpm2" is used, a key is added to the LUKS2
-superblock, configurable with the ``--key-file=`` option to
-``systemd-repart``. If "tpm2" or "key-file+tpm2" is
-used, a key is added to the LUKS2 superblock that is enrolled to the local TPM2 chip, as configured
-with the ``--tpm2-device=`` and ``--tpm2-pcrs=`` options to
-``systemd-repart``.
-
-When used this slightly alters the size allocation logic as the implicit, minimal size limits
-of ``Format=`` and ``CopyBlocks=`` are increased by the space necessary
-for the LUKS2 superblock (see above).
-
-This option has no effect if the partition already exists.
-
-.. only:: html
-
-   .. versionadded:: 247
-
-``Verity=``
------------
-
-Takes one of "off", "data",
-"hash" or "signature". Defaults to "off". If set
-to "off" or "data", the partition is populated with content as
-specified by ``CopyBlocks=`` or ``CopyFiles=``. If set to
-"hash", the partition will be populated with verity hashes from the matching verity
-data partition. If set to "signature", the partition will be populated with a JSON
-object containing a signature of the verity root hash of the matching verity hash partition.
-
-A matching verity partition is a partition with the same verity match key (as configured with
-``VerityMatchKey=``).
-
-If not explicitly configured, the data partition's UUID will be set to the first 128
-bits of the verity root hash. Similarly, if not configured, the hash partition's UUID will be set to
-the final 128 bits of the verity root hash. The verity root hash itself will be included in the
-output of ``systemd-repart``.
-
-This option has no effect if the partition already exists.
-
-Usage of this option in combination with ``Encrypt=`` is not supported.
-
-For each unique ``VerityMatchKey=`` value, a single verity data partition
-("Verity=data") and a single verity hash partition ("Verity=hash")
-must be defined.
-
-.. only:: html
-
-   .. versionadded:: 252
-
-``VerityMatchKey=``
--------------------
-
-Takes a short, user-chosen identifier string. This setting is used to find sibling
-verity partitions for the current verity partition. See the description for
-``Verity=``.
-
-.. only:: html
-
-   .. versionadded:: 252
-
-``VerityDataBlockSizeBytes=``
------------------------------
-
-Configures the data block size of the generated verity hash partition. Must be between 512 and
-4096 bytes and must be a power of 2. Defaults to the sector size if configured explicitly, or the underlying
-block device sector size, or 4K if systemd-repart is not operating on a block device.
-
-.. only:: html
-
-   .. versionadded:: 255
-
-``VerityHashBlockSizeBytes=``
------------------------------
-
-Configures the hash block size of the generated verity hash partition. Must be between 512 and
-4096 bytes and must be a power of 2. Defaults to the sector size if configured explicitly, or the underlying
-block device sector size, or 4K if systemd-repart is not operating on a block device.
-
-.. only:: html
-
-   .. versionadded:: 255
-
-``FactoryReset=``
------------------
-
-Takes a boolean argument. If specified the partition is marked for removal during a
-factory reset operation. This functionality is useful to implement schemes where images can be reset
-into their original state by removing partitions and creating them anew. Defaults to off.
-
-.. only:: html
-
-   .. versionadded:: 245
-
-``Flags=``
-----------
-
-Configures the 64-bit GPT partition flags field to set for the partition when creating
-it. This option has no effect if the partition already exists. If not specified the flags values is
-set to all zeroes, except for the three bits that can also be configured via
-``NoAuto=``, ``ReadOnly=`` and ``GrowFileSystem=``; see
-below for details on the defaults for these three flags. Specify the flags value in hexadecimal (by
-prefixing it with "0x"), binary (prefix "0b") or decimal (no
-prefix).
-
-.. only:: html
-
-   .. versionadded:: 249
-
-``NoAuto=, ReadOnly=, GrowFileSystem=``
----------------------------------------
-
-Configures the No-Auto, Read-Only and Grow-File-System partition flags (bit 63, 60
-and 59) of the partition table entry, as defined by the `Discoverable Partitions Specification <https://uapi-group.org/specifications/specs/discoverable_partitions_specification>`_. Only
-available for partition types supported by the specification. This option is a friendly way to set
-bits 63, 60 and 59 of the partition flags value without setting any of the other bits, and may be set
-via ``Flags=`` too, see above.
-
-If ``Flags=`` is used in conjunction with one or more of
-``NoAuto=``/``ReadOnly=``/``GrowFileSystem=`` the latter
-control the value of the relevant flags, i.e. the high-level settings
-``NoAuto=``/``ReadOnly=``/``GrowFileSystem=`` override
-the relevant bits of the low-level setting ``Flags=``.
-
-Note that the three flags affect only automatic partition mounting, as implemented by
-:ref:`systemd-gpt-auto-generator(8)`
-or the ``--image=`` option of various commands (such as
-:ref:`systemd-nspawn(1)`). It
-has no effect on explicit mounts, such as those done via :man-pages:`mount(8)` or
-:man-pages:`fstab(5)`.
-
-If both bit 50 and 59 are set for a partition (i.e. the partition is marked both read-only and
-marked for file system growing) the latter is typically without effect: the read-only flag takes
-precedence in most tools reading these flags, and since growing the file system involves writing to
-the partition it is consequently ignored.
-
-``NoAuto=`` defaults to off. ``ReadOnly=`` defaults to on for
-Verity partition types, and off for all others. ``GrowFileSystem=`` defaults to on for
-all partition types that support it, except if the partition is marked read-only (and thus
-effectively, defaults to off for Verity partitions).
-
-.. only:: html
-
-   .. versionadded:: 249
-
-``SplitName=``
---------------
-
-Configures the suffix to append to split artifacts when the ``--split``
-option of
-:ref:`systemd-repart(8)` is
-used. Simple specifier expansion is supported, see below. Defaults to "%t". To
-disable split artifact generation for a partition, set ``SplitName=`` to
-"-".
-
-.. only:: html
-
-   .. versionadded:: 252
-
-``Minimize=``
--------------
-
-Takes one of "off", "best", and
-"guess" (alternatively, also accepts a boolean value, which is mapped to
-"off" when false, and "best" when true). Defaults to
-"off". If set to "best", the partition will have the minimal size
-required to store the sources configured with ``CopyFiles=``. "best"
-is currently only supported for read-only filesystems. If set to "guess", the
-partition is created at least as big as required to store the sources configured with
-``CopyFiles=``. Note that unless the filesystem is a read-only filesystem,
-``systemd-repart`` will have to populate the filesystem twice to guess the minimal
-required size, so enabling this option might slow down repart when populating large partitions.
-
-.. only:: html
-
-   .. versionadded:: 253
-
-``MountPoint=``
----------------
-
-Specifies where and how the partition should be mounted. Takes at least one and at
-most two fields separated with a colon (":"). The first field specifies where the
-partition should be mounted. The second field specifies extra mount options to append to the default
-mount options. These fields correspond to the second and fourth column of the
-:man-pages:`fstab(5)`
-format. This setting may be specified multiple times to mount the partition multiple times. This can
-be used to add mounts for different btrfs subvolumes located on the same btrfs partition.
-
-Note that this setting is only taken into account when ``--generate-fstab=`` is
-specified on the ``systemd-repart`` command line.
-
-.. only:: html
-
-   .. versionadded:: 256
-
-``EncryptedVolume=``
---------------------
-
-Specify how the encrypted partition should be set up. Takes at least one and at most
-three fields separated with a colon (":"). The first field specifies the encrypted
-volume name under ``/dev/mapper/``. If not specified, "luks-UUID"
-will be used where "UUID" is the LUKS UUID. The second field specifies the keyfile
-to use following the same format as specified in crypttab. The third field specifies a
-comma-delimited list of crypttab options. These fields correspond to the first, third and fourth
-column of the
-:ref:`crypttab(5)` format.
-
-Note that this setting is only taken into account when ``--generate-crypttab=``
-is specified on the ``systemd-repart`` command line.
-
-.. only:: html
-
-   .. versionadded:: 256
-
-Specifiers
-==========
-
-Specifiers may be used in the ``Label=``, ``CopyBlocks=``,
-``CopyFiles=``, ``MakeDirectories=``, ``SplitName=``
-settings. The following expansions are understood:
-
-.. list-table:: Specifiers available
-   :header-rows: 1
-
-   * - Specifier
-     - Meaning
-     - Details
-
-Additionally, for the ``SplitName=`` setting, the following specifiers are also
-understood:
-
-.. list-table:: Specifiers available
-   :header-rows: 1
-
-   * - Specifier
-     - Meaning
-     - Details
-   * - "%T"
-     - Partition Type UUID
-     - The partition type UUID, as configured with ``Type=``
-   * - "%t"
-     - Partition Type Identifier
-     - The partition type identifier corresponding to the partition type UUID
-   * - "%U"
-     - Partition UUID
-     - The partition UUID, as configured with ``UUID=``
-   * - "%n"
-     - Partition Number
-     - The partition number assigned to the partition
-
-Environment
-===========
-
-Extra filesystem formatting options can be provided using filesystem-specific environment variables:
-``$SYSTEMD_REPART_MKFS_OPTIONS_BTRFS``, ``$SYSTEMD_REPART_MKFS_OPTIONS_XFS``,
-``$SYSTEMD_REPART_MKFS_OPTIONS_VFAT``, ``$SYSTEMD_REPART_MKFS_OPTIONS_EROFS``,
-and ``$SYSTEMD_REPART_MKFS_OPTIONS_SQUASHFS``. Each variable accepts valid
-``mkfs.<filesystem>`` command-line arguments.
-The content of those variables is passed as-is to the command, without any verification.
-
-Examples
-========
-
-Grow the root partition to the full disk size at first boot
------------------------------------------------------------
-
-With the following file the root partition is automatically grown to the full disk if possible
-during boot.
-
-.. code-block:: sh
-
-   # /usr/lib/repart.d/50-root.conf
-   [Partition]
-   Type=root
-
-Create a swap and home partition automatically on boot, if missing
-------------------------------------------------------------------
-
-The home partition gets all available disk space while the swap partition gets 1G at most and 64M
-at least. We set a priority > 0 on the swap partition to ensure the swap partition is not used if not
-enough space is available. For every three bytes assigned to the home partition the swap partition gets
-assigned one.
-
-.. code-block:: sh
-
-   # /usr/lib/repart.d/60-home.conf
-   [Partition]
-   Type=home
-
-.. code-block:: sh
-
-   # /usr/lib/repart.d/70-swap.conf
-   [Partition]
-   Type=swap
-   SizeMinBytes=64M
-   SizeMaxBytes=1G
-   Priority=1
-   Weight=333
-
-Create B partitions in an A/B Verity setup, if missing
-------------------------------------------------------
-
-Let's say the vendor intends to update OS images in an A/B setup, i.e. with two root partitions
-(and two matching Verity partitions) that shall be used alternatingly during upgrades. To minimize
-image sizes the original image is shipped only with one root and one Verity partition (the "A" set),
-and the second root and Verity partitions (the "B" set) shall be created on first boot on the free
-space on the medium.
-
-.. code-block:: sh
-
-   # /usr/lib/repart.d/50-root.conf
-   [Partition]
-   Type=root
-   SizeMinBytes=512M
-   SizeMaxBytes=512M
-
-.. code-block:: sh
-
-   # /usr/lib/repart.d/60-root-verity.conf
-   [Partition]
-   Type=root-verity
-   SizeMinBytes=64M
-   SizeMaxBytes=64M
-
-The definitions above cover the "A" set of root partition (of a fixed 512M size) and Verity
-partition for the root partition (of a fixed 64M size). Let's use symlinks to create the "B" set of
-partitions, since after all they shall have the same properties and sizes as the "A" set.
-
-.. code-block:: sh
-
-   # ln -s 50-root.conf /usr/lib/repart.d/70-root-b.conf
-   # ln -s 60-root-verity.conf /usr/lib/repart.d/80-root-verity-b.conf
-
-Create a data partition and corresponding verity partitions from a OS tree
---------------------------------------------------------------------------
-
-Assuming we have an OS tree at ``/var/tmp/os-tree`` that we want
-to package in a root partition together with matching verity partitions, we can do so as follows:
-
-.. code-block:: sh
-
-   # 50-root.conf
-   [Partition]
-   Type=root
-   CopyFiles=/var/tmp/os-tree
-   Verity=data
-   VerityMatchKey=root
-   Minimize=guess
-
-.. code-block:: sh
-
-   # 60-root-verity.conf
-   [Partition]
-   Type=root-verity
-   Verity=hash
-   VerityMatchKey=root
-   # Explicitly set the hash and data block size to 4K
-   VerityDataBlockSizeBytes=4096
-   VerityHashBlockSizeBytes=4096
-   Minimize=best
-
-.. code-block:: sh
-
-   # 70-root-verity-sig.conf
-   [Partition]
-   Type=root-verity-sig
-   Verity=signature
-   VerityMatchKey=root
-
-See Also
-========
-
-:ref:`systemd(1)`, :ref:`systemd-repart(8)`, :man-pages:`sfdisk(8)`, :ref:`systemd-cryptenroll(1)`

doc-migration/source/docs/runlevel.rst

@@ -1,113 +0,0 @@
-.. SPDX-License-Identifier: LGPL-2.1-or-later:
-
-:title: runlevel
-
-:manvolnum: 8
-
-.. _runlevel(8):
-
-===========
-runlevel(8)
-===========
-
-.. only:: html
-
-   runlevel — Print previous and current SysV runlevel
-   ###################################################
-
-   Synopsis
-   ########
-
-``runlevel`` [options...]
-
-Overview
-========
-
-"Runlevels" are an obsolete way to start and stop groups of
-services used in SysV init. systemd provides a compatibility layer
-that maps runlevels to targets, and associated binaries like
-``runlevel``. Nevertheless, only one runlevel can
-be "active" at a given time, while systemd can activate multiple
-targets concurrently, so the mapping to runlevels is confusing
-and only approximate. Runlevels should not be used in new code,
-and are mostly useful as a shorthand way to refer the matching
-systemd targets in kernel boot parameters.
-
-.. list-table:: Mapping between runlevels and systemd targets
-   :header-rows: 1
-
-   * - Runlevel
-     - Target
-   * - 0
-     - ``poweroff.target``
-   * - 1
-     - ``rescue.target``
-   * - 2, 3, 4
-     - ``multi-user.target``
-   * - 5
-     - ``graphical.target``
-   * - 6
-     - ``reboot.target``
-
-Description
-===========
-
-``runlevel`` prints the previous and current
-SysV runlevel if they are known.
-
-The two runlevel characters are separated by a single space
-character. If a runlevel cannot be determined, N is printed
-instead. If neither can be determined, the word "unknown" is
-printed.
-
-Unless overridden in the environment, this will check the
-utmp database for recent runlevel changes.
-
-Options
-=======
-
-The following option is understood:
-
-``--help``
-----------
-
-Exit status
-===========
-
-If one or both runlevels could be determined, 0 is returned,
-a non-zero failure code otherwise.
-
-Environment
-===========
-
-``$RUNLEVEL``
--------------
-
-If :directive:environment-variables:var:`$RUNLEVEL` is set,
-``runlevel`` will print this value as current
-runlevel and ignore utmp.
-
-``$PREVLEVEL``
---------------
-
-If :directive:environment-variables:var:`$PREVLEVEL` is set,
-``runlevel`` will print this value as previous
-runlevel and ignore utmp.
-
-Files
-=====
-
-``/run/utmp``
--------------
-
-The utmp database ``runlevel`` reads the previous and current runlevel
-from.
-
-.. only:: html
-
-   .. versionadded:: 237
-
-See Also
-========
-
-:ref:`systemd(1)`, :ref:`systemd.target(5)`, :ref:`systemctl(1)`

doc-migration/source/index.rst

@@ -23,12 +23,10 @@ systemd — System and Service Manager
    :maxdepth: 1
 
    docs/busctl
-   docs/runlevel
    docs/journalctl
    docs/os-release
    docs/systemd
    docs/systemD-directives
-   docs/repart.d
    docs/includes/sd_journal_get_data
 
 Indices and tables

src/nsresourced/nsresourced-manager.c

@@ -6,9 +6,7 @@
 #include "sd-daemon.h"
 
 #include "bpf-dlopen.h"
-#if HAVE_VMLINUX_H
 #include "bpf-link.h"
-#endif
 #include "build-path.h"
 #include "common-signal.h"
 #include "env-util.h"

src/partition/repart.c

@@ -304,6 +304,19 @@ static SubvolumeFlags subvolume_flags_from_string(const char *s) {
         return flags;
 }
 
+static char* subvolume_flags_to_string(SubvolumeFlags flags) {
+        const char *l[CONST_LOG2U(_SUBVOLUME_FLAGS_MASK + 1) + 1]; /* one string per known flag at most */
+        size_t m = 0;
+
+        if (FLAGS_SET(flags, SUBVOLUME_RO))
+                l[m++] = "ro";
+
+        assert(m < ELEMENTSOF(l));
+        l[m] = NULL;
+
+        return strv_join((char**) l, ",");
+}
+
 typedef struct Subvolume {
         char *path;
         SubvolumeFlags flags;
@@ -2425,14 +2438,6 @@ static int partition_read_definition(Partition *p, const char *path, const char
                                   "SizeMinBytes=/SizeMaxBytes= cannot be used with Verity=%s.",
                                   verity_mode_to_string(p->verity));
 
-        if (!ordered_hashmap_isempty(p->subvolumes) && arg_offline > 0)
-                return log_syntax(NULL, LOG_ERR, path, 1, SYNTHETIC_ERRNO(EOPNOTSUPP),
-                                  "Subvolumes= cannot be used with --offline=yes.");
-
-        if (p->default_subvolume && arg_offline > 0)
-                return log_syntax(NULL, LOG_ERR, path, 1, SYNTHETIC_ERRNO(EOPNOTSUPP),
-                                  "DefaultSubvolume= cannot be used with --offline=yes.");
-
         if (p->default_subvolume && !ordered_hashmap_contains(p->subvolumes, p->default_subvolume))
                 return log_syntax(NULL, LOG_ERR, path, 1, SYNTHETIC_ERRNO(EINVAL),
                                   "DefaultSubvolume= must be one of the paths in Subvolumes=.");
@@ -4281,7 +4286,7 @@ static int prepare_temporary_file(Context *context, PartitionTarget *t, uint64_t
 
 static bool loop_device_error_is_fatal(const Partition *p, int r) {
         assert(p);
-        return arg_offline == 0 || (r != -ENOENT && !ERRNO_IS_PRIVILEGE(r)) || !ordered_hashmap_isempty(p->subvolumes) || p->default_subvolume;
+        return arg_offline == 0 || (r != -ENOENT && !ERRNO_IS_PRIVILEGE(r));
 }
 
 static int partition_target_prepare(
@@ -5788,6 +5793,38 @@ static int partition_populate_filesystem(Context *context, Partition *p, const c
         return 0;
 }
 
+static int append_btrfs_subvols(char ***l, OrderedHashmap *subvolumes, const char *default_subvolume) {
+        Subvolume *subvolume;
+        int r;
+
+        assert(l);
+
+        ORDERED_HASHMAP_FOREACH(subvolume, subvolumes) {
+                _cleanup_free_ char *s = NULL, *f = NULL;
+
+                s = strdup(subvolume->path);
+                if (!s)
+                        return log_oom();
+
+                f = subvolume_flags_to_string(subvolume->flags);
+                if (!f)
+                        return log_oom();
+
+                if (streq_ptr(subvolume->path, default_subvolume) &&
+                    !strextend_with_separator(&f, ",", "default"))
+                        return log_oom();
+
+                if (!isempty(f) && !strextend_with_separator(&s, ":", f))
+                        return log_oom();
+
+                r = strv_extend_many(l, "--subvol", s);
+                if (r < 0)
+                        return log_oom();
+        }
+
+        return 0;
+}
+
 static int finalize_extra_mkfs_options(const Partition *p, const char *root, char ***ret) {
         _cleanup_strv_free_ char **sv = NULL;
         int r;
@@ -5801,6 +5838,18 @@ static int finalize_extra_mkfs_options(const Partition *p, const char *root, cha
                                        "Failed to determine mkfs command line options for '%s': %m",
                                        p->format);
 
+        if (partition_needs_populate(p) && root && streq(p->format, "btrfs")) {
+                r = append_btrfs_subvols(&sv, p->subvolumes, p->default_subvolume);
+                if (r < 0)
+                        return r;
+
+                if (p->suppressing) {
+                        r = append_btrfs_subvols(&sv, p->suppressing->subvolumes, NULL);
+                        if (r < 0)
+                                return r;
+                }
+        }
+
         *ret = TAKE_PTR(sv);
         return 0;
 }