From 02b6d696ef762dbaf204ad8cfe75a87f1375f545 Mon Sep 17 00:00:00 2001 From: Simon de Vlieger Date: Thu, 14 Mar 2024 10:32:56 +0100 Subject: [PATCH] stages: consistent docstrings Make docstrings consistent across stages regarding whitespace and summary line. --- stages/org.osbuild.bootc.install-to-filesystem | 3 ++- stages/org.osbuild.chown | 1 + stages/org.osbuild.coreos.platform | 2 ++ stages/org.osbuild.fdo | 2 ++ stages/org.osbuild.gcp.guest-agent.conf | 2 +- stages/org.osbuild.grub2.iso | 1 - stages/org.osbuild.isolinux | 1 - stages/org.osbuild.ostree.post-copy | 3 ++- stages/org.osbuild.ostree.sign | 4 ++-- stages/org.osbuild.pacman.conf | 2 +- stages/org.osbuild.pacman.mirrorlist.conf | 2 +- stages/org.osbuild.sysconfig | 2 -- stages/org.osbuild.yum.config | 1 + 13 files changed, 15 insertions(+), 11 deletions(-) diff --git a/stages/org.osbuild.bootc.install-to-filesystem b/stages/org.osbuild.bootc.install-to-filesystem index 2494b726..a299f1af 100755 --- a/stages/org.osbuild.bootc.install-to-filesystem +++ b/stages/org.osbuild.bootc.install-to-filesystem @@ -1,5 +1,6 @@ #!/usr/bin/python3 -"""Run bootc install to-filesystem +""" +Run bootc install to-filesystem Note that this needs the disk.img in the inputs as one continous devices so that bootupd can install grub to the mbr. It also needs diff --git a/stages/org.osbuild.chown b/stages/org.osbuild.chown index 2d95f71d..9dc8f733 100755 --- a/stages/org.osbuild.chown +++ b/stages/org.osbuild.chown @@ -1,6 +1,7 @@ #!/usr/bin/python3 """ Change file owner and group + Change the file user and/or group ownership of one or more files or directories inside the tree. Notes: diff --git a/stages/org.osbuild.coreos.platform b/stages/org.osbuild.coreos.platform index 59833070..b21b1f67 100755 --- a/stages/org.osbuild.coreos.platform +++ b/stages/org.osbuild.coreos.platform @@ -1,5 +1,7 @@ #!/usr/bin/python3 """ +Setup a CoreOS platform + In CoreOS we have the concept of a platform (i.e. AWS, GCP, Metal, QEMU) where each platform has its own provided disk image with slightly differing settings/behavior. This stage will perform the necessary diff --git a/stages/org.osbuild.fdo b/stages/org.osbuild.fdo index fde6f510..cbfdd342 100755 --- a/stages/org.osbuild.fdo +++ b/stages/org.osbuild.fdo @@ -1,5 +1,7 @@ #!/usr/bin/python3 """ +FDO initial DIUN certificates + FDO stage to write down the initial DIUN pub key root certificates to be read by the manufacturer client diff --git a/stages/org.osbuild.gcp.guest-agent.conf b/stages/org.osbuild.gcp.guest-agent.conf index 91556ed7..8e9dedb8 100755 --- a/stages/org.osbuild.gcp.guest-agent.conf +++ b/stages/org.osbuild.gcp.guest-agent.conf @@ -1,6 +1,6 @@ #!/usr/bin/python3 """ -Crate or modify the GCP guest-agent config +Create or modify the GCP guest-agent config Create or modify the GCP guest-agent config, depending on the scope either at: diff --git a/stages/org.osbuild.grub2.iso b/stages/org.osbuild.grub2.iso index 729c8296..e05c54b3 100755 --- a/stages/org.osbuild.grub2.iso +++ b/stages/org.osbuild.grub2.iso @@ -2,7 +2,6 @@ """ Create a boot filesystem tree, can be consumed to create an efiboot.img. - """ import os diff --git a/stages/org.osbuild.isolinux b/stages/org.osbuild.isolinux index 36081916..d4bda50c 100755 --- a/stages/org.osbuild.isolinux +++ b/stages/org.osbuild.isolinux @@ -1,7 +1,6 @@ #!/usr/bin/python3 """ Create an isolinux bootloader - """ import os diff --git a/stages/org.osbuild.ostree.post-copy b/stages/org.osbuild.ostree.post-copy index 269f807e..d4656345 100755 --- a/stages/org.osbuild.ostree.post-copy +++ b/stages/org.osbuild.ostree.post-copy @@ -1,5 +1,6 @@ #!/usr/bin/python3 -"""Apply post-copy updates to an ostree repo/deployment +""" +Apply post-copy updates to an ostree repo/deployment The way osbuild works the ostree deployment is built in a chroot and stored as a regular directory of files before finally being copied to diff --git a/stages/org.osbuild.ostree.sign b/stages/org.osbuild.ostree.sign index caa2d125..30c3b9ee 100755 --- a/stages/org.osbuild.ostree.sign +++ b/stages/org.osbuild.ostree.sign @@ -1,11 +1,11 @@ #!/usr/bin/python3 -"""Sign a commit in an ostree repo +""" +Sign a commit in an ostree repo Given an ostree commit (referenced by a ref) in a repo and an ed25519 secret key this adds a signature to the commit detached metadata. This commit can then be used to validate the commit, during ostree pull, during boot, or at any other time. - """ import os diff --git a/stages/org.osbuild.pacman.conf b/stages/org.osbuild.pacman.conf index 30e612af..fd25cb6d 100755 --- a/stages/org.osbuild.pacman.conf +++ b/stages/org.osbuild.pacman.conf @@ -1,6 +1,6 @@ #!/usr/bin/python3 """ -configure pacman +Configure pacman """ import os import sys diff --git a/stages/org.osbuild.pacman.mirrorlist.conf b/stages/org.osbuild.pacman.mirrorlist.conf index ec5cebfc..7ffea19e 100755 --- a/stages/org.osbuild.pacman.mirrorlist.conf +++ b/stages/org.osbuild.pacman.mirrorlist.conf @@ -1,6 +1,6 @@ #!/usr/bin/python3 """ -configure pacman's mirrorlist +Configure pacman's mirrorlist """ import os import pathlib diff --git a/stages/org.osbuild.sysconfig b/stages/org.osbuild.sysconfig index 031a92ad..96d7050a 100755 --- a/stages/org.osbuild.sysconfig +++ b/stages/org.osbuild.sysconfig @@ -1,6 +1,5 @@ #!/usr/bin/python3 """ - Configure sysconfig files The sysconfig directory contains a variety of system configuration files. @@ -48,7 +47,6 @@ Network-scripts supports the params: - userctl(USERCTL) of type boolean This stage will overwrite existing files. - """ import os diff --git a/stages/org.osbuild.yum.config b/stages/org.osbuild.yum.config index fc3f30c4..05e8bc25 100755 --- a/stages/org.osbuild.yum.config +++ b/stages/org.osbuild.yum.config @@ -6,6 +6,7 @@ The stage currently supports configuring http_caching in YUM config and locales in langpacks plugin. If the config files don't exist, they are created. """ + import os import sys