From 0f5db9a2830795f11bafe7d94035c8b0ff8f1db2 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Florian=20Sch=C3=BCller?= Date: Wed, 31 Jul 2024 19:24:44 +0200 Subject: [PATCH] stages: fix some documentation typos to prepare for spellchecking --- .../org.osbuild.bootc.install-to-filesystem.meta.json | 4 ++-- stages/org.osbuild.bootc.install.config.meta.json | 2 +- stages/org.osbuild.bootupd.gen-metadata.meta.json | 2 +- stages/org.osbuild.chrony.meta.json | 4 ++-- stages/org.osbuild.copy.meta.json | 2 +- stages/org.osbuild.coreos.platform.meta.json | 2 +- stages/org.osbuild.crypttab.meta.json | 2 +- stages/org.osbuild.fdo.meta.json | 2 +- stages/org.osbuild.fix-bls.meta.json | 10 +++++----- stages/org.osbuild.fstab.meta.json | 4 ++-- 10 files changed, 17 insertions(+), 17 deletions(-) diff --git a/stages/org.osbuild.bootc.install-to-filesystem.meta.json b/stages/org.osbuild.bootc.install-to-filesystem.meta.json index f2367b52..02268b27 100644 --- a/stages/org.osbuild.bootc.install-to-filesystem.meta.json +++ b/stages/org.osbuild.bootc.install-to-filesystem.meta.json @@ -1,9 +1,9 @@ { "summary": "Run bootc install to-filesystem", "description": [ - "Note that this needs the disk.img in the inputs as one continous", + "Note that this needs the disk.img in the inputs as one continuous", "devices so that bootupd can install grub to the mbr. It also needs", - "all relevant mount points for booting (e.g. /boot, /boot/efi) in", + "all relevant mount points for booting (e.g. `/boot`, `/boot/efi`) in", "mounted in the \"mounts\" path.", "Buildhost commands used: bootc" ], diff --git a/stages/org.osbuild.bootc.install.config.meta.json b/stages/org.osbuild.bootc.install.config.meta.json index a5f7e379..37fe6123 100644 --- a/stages/org.osbuild.bootc.install.config.meta.json +++ b/stages/org.osbuild.bootc.install.config.meta.json @@ -3,7 +3,7 @@ "description": [ "The bootc install process supports some basic customization. This", "configuration file is in TOML format, and will be discovered by the", - "installation process in via drop-in files in /usr/lib/bootc/install that", + "installation process via drop-in files in `/usr/lib/bootc/install` that", "are processed in alphanumerical order.", "The individual files are merged into a single final installation config, so", "it is supported for e.g. a container base image to provide a default root", diff --git a/stages/org.osbuild.bootupd.gen-metadata.meta.json b/stages/org.osbuild.bootupd.gen-metadata.meta.json index bfc4e4fc..41d52910 100644 --- a/stages/org.osbuild.bootupd.gen-metadata.meta.json +++ b/stages/org.osbuild.bootupd.gen-metadata.meta.json @@ -1,5 +1,5 @@ { - "summary": "Transforms /usr/lib/ostree-boot into a bootupd-compatible update payload.", + "summary": "Transforms `/usr/lib/ostree-boot` into a bootupd-compatible update payload.", "description": [ "Scrapes metadata (e.g. RPM versions) about shim/grub and puts them along with their component files in", "`/usr/lib/bootupd/updates/`.", diff --git a/stages/org.osbuild.chrony.meta.json b/stages/org.osbuild.chrony.meta.json index f52cd479..caf72909 100644 --- a/stages/org.osbuild.chrony.meta.json +++ b/stages/org.osbuild.chrony.meta.json @@ -19,11 +19,11 @@ " - 'maxpoll'", " - 'iburst' (defaults to true)", " - 'prefer' (defaults to false)", - "The 'leapsectz' option configures chrony behavior related to automatic checking", + "The `leapsectz` option configures chrony behavior related to automatic checking", "of the next occurrence of the leap second, using the provided timezone. Its", "value is a string representing a timezone from the system tz database (e.g.", "'right/UTC'). If an empty string is provided, then all occurrences of", - "'leapsectz' directive are removed from the configuration.", + "`leapsectz` directive are removed from the configuration.", "Constraints:", " - Exactly one of 'timeservers' or 'servers' options must be provided." ], diff --git a/stages/org.osbuild.copy.meta.json b/stages/org.osbuild.copy.meta.json index 439ec3ff..2fca6b87 100644 --- a/stages/org.osbuild.copy.meta.json +++ b/stages/org.osbuild.copy.meta.json @@ -3,7 +3,7 @@ "description": [ "Stage to copy items, that is files or trees, from inputs to mount", "points or the tree. Multiple items can be copied. The source and", - "destination is an url. Supported locations ('schemes') are `tree`,", + "destination is an URL. Supported locations ('schemes') are `tree`,", "`mount` and `input`.", "The path format follows the rsync convention that if the paths", "ends with a slash `/` the content of that directory is copied not", diff --git a/stages/org.osbuild.coreos.platform.meta.json b/stages/org.osbuild.coreos.platform.meta.json index b548ce05..3d23a3fc 100644 --- a/stages/org.osbuild.coreos.platform.meta.json +++ b/stages/org.osbuild.coreos.platform.meta.json @@ -15,7 +15,7 @@ " are primarily console settings.", "4. Apply any platform specific kernel arguments along with the", " `ignition.platform.id={platform-name}` kernel argument.", - "5. Create the grub console.cfg file and apply any platform", + "5. Create the grub `console.cfg` file and apply any platform", " specific grub console configuration.", "This stage is highly CoreOS specific and subject to change in the", "future if/when we change the way platform specific information is", diff --git a/stages/org.osbuild.crypttab.meta.json b/stages/org.osbuild.crypttab.meta.json index 0f2bb1a2..1c219170 100644 --- a/stages/org.osbuild.crypttab.meta.json +++ b/stages/org.osbuild.crypttab.meta.json @@ -1,5 +1,5 @@ { - "summary": "Create /etc/crypttab entries for encrypted block devices", + "summary": "Create `/etc/crypttab` entries for encrypted block devices", "description": [ "See crypttab(5) for a detailed description of the format but in brief:", "each item in the list of `volumes` describes an encrypted block device", diff --git a/stages/org.osbuild.fdo.meta.json b/stages/org.osbuild.fdo.meta.json index 9c61693b..e89c745e 100644 --- a/stages/org.osbuild.fdo.meta.json +++ b/stages/org.osbuild.fdo.meta.json @@ -3,7 +3,7 @@ "description": [ "FDO stage to write down the initial DIUN pub key root certificates", "to be read by the manufacturer client", - "This will create a '/fdo_diun_root_certs.pem' with content", + "This will create a `/fdo_diun_root_certs.pem` with content", "specified via the `rootcerts` input." ], "schema_2": { diff --git a/stages/org.osbuild.fix-bls.meta.json b/stages/org.osbuild.fix-bls.meta.json index 91a5579d..cdbb7ec8 100644 --- a/stages/org.osbuild.fix-bls.meta.json +++ b/stages/org.osbuild.fix-bls.meta.json @@ -1,16 +1,16 @@ { - "summary": "Fix paths in /boot/loader/entries", + "summary": "Fix paths in `/boot/loader/entries`", "description": [ - "Fixes paths in /boot/loader/entries that have incorrect paths for /boot.", - "This happens because some boot loader config tools (e.g. grub2-mkrelpath)", - "examine /proc/self/mountinfo to find the \"real\" path to /boot, and find the", + "Fixes paths in `/boot/loader/entries` that have incorrect paths for `/boot`.", + "This happens because some boot loader config tools (e.g. `grub2-mkrelpath`)", + "examine `/proc/self/mountinfo` to find the \"real\" path to `/boot`, and find the", "path to the osbuild tree - which won't be valid at boot time for this image.", "The paths in the Bootloader Specification are relative to the partition", "they are located on, i.e. `/boot/loader/...` if `/boot` is on the root", "file-system partition. If `/boot` is on a separate partition, the correct", "path would be `/loader/.../` The `prefix` can be used to adjust for that.", "By default it is `/boot`, i.e. assumes `/boot` is on the root file-system.", - "This stage reads and (re)writes all .conf files in /boot/loader/entries." + "This stage reads and (re)writes all `.conf` files in `/boot/loader/entries`." ], "schema": { "additionalProperties": false, diff --git a/stages/org.osbuild.fstab.meta.json b/stages/org.osbuild.fstab.meta.json index f2810a5b..fe0b6ba6 100644 --- a/stages/org.osbuild.fstab.meta.json +++ b/stages/org.osbuild.fstab.meta.json @@ -1,9 +1,9 @@ { - "summary": "Create /etc/fstab entries for filesystems", + "summary": "Create `/etc/fstab` entries for filesystems", "description": [ "Each filesystem item must have at least the fs_spec, i.e `uuid`,", "`label`, `partlabel` or `device` and a `path` (mount point).", - "This stage replaces /etc/fstab, removing any existing entries.", + "This stage replaces `/etc/fstab`, removing any existing entries.", "NB: The ostree configuration options are experimental and might", "be replaced with a different mechanism in the near future." ],