stages: consistent docstrings

Make docstrings consistent across stages regarding whitespace and
summary line.
This commit is contained in:
Simon de Vlieger 2024-03-14 10:32:56 +01:00 committed by Achilleas Koutsou
parent 352bf5cd52
commit 02b6d696ef
13 changed files with 15 additions and 11 deletions

View file

@ -1,5 +1,6 @@
#!/usr/bin/python3 #!/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 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 devices so that bootupd can install grub to the mbr. It also needs

View file

@ -1,6 +1,7 @@
#!/usr/bin/python3 #!/usr/bin/python3
""" """
Change file owner and group Change file owner and group
Change the file user and/or group ownership of one or more files or directories inside the tree. Change the file user and/or group ownership of one or more files or directories inside the tree.
Notes: Notes:

View file

@ -1,5 +1,7 @@
#!/usr/bin/python3 #!/usr/bin/python3
""" """
Setup a CoreOS platform
In CoreOS we have the concept of a platform (i.e. AWS, GCP, Metal, QEMU) 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 where each platform has its own provided disk image with slightly
differing settings/behavior. This stage will perform the necessary differing settings/behavior. This stage will perform the necessary

View file

@ -1,5 +1,7 @@
#!/usr/bin/python3 #!/usr/bin/python3
""" """
FDO initial DIUN certificates
FDO stage to write down the initial DIUN pub key root certificates FDO stage to write down the initial DIUN pub key root certificates
to be read by the manufacturer client to be read by the manufacturer client

View file

@ -1,6 +1,6 @@
#!/usr/bin/python3 #!/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 Create or modify the GCP guest-agent config, depending on the
scope either at: scope either at:

View file

@ -2,7 +2,6 @@
""" """
Create a boot filesystem tree, can be consumed to create Create a boot filesystem tree, can be consumed to create
an efiboot.img. an efiboot.img.
""" """
import os import os

View file

@ -1,7 +1,6 @@
#!/usr/bin/python3 #!/usr/bin/python3
""" """
Create an isolinux bootloader Create an isolinux bootloader
""" """
import os import os

View file

@ -1,5 +1,6 @@
#!/usr/bin/python3 #!/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 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 stored as a regular directory of files before finally being copied to

View file

@ -1,11 +1,11 @@
#!/usr/bin/python3 #!/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 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. secret key this adds a signature to the commit detached metadata.
This commit can then be used to validate the commit, during ostree This commit can then be used to validate the commit, during ostree
pull, during boot, or at any other time. pull, during boot, or at any other time.
""" """
import os import os

View file

@ -1,6 +1,6 @@
#!/usr/bin/python3 #!/usr/bin/python3
""" """
configure pacman Configure pacman
""" """
import os import os
import sys import sys

View file

@ -1,6 +1,6 @@
#!/usr/bin/python3 #!/usr/bin/python3
""" """
configure pacman's mirrorlist Configure pacman's mirrorlist
""" """
import os import os
import pathlib import pathlib

View file

@ -1,6 +1,5 @@
#!/usr/bin/python3 #!/usr/bin/python3
""" """
Configure sysconfig files Configure sysconfig files
The sysconfig directory contains a variety of system configuration 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 - userctl(USERCTL) of type boolean
This stage will overwrite existing files. This stage will overwrite existing files.
""" """
import os import os

View file

@ -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 locales in langpacks plugin. If the config files don't exist, they
are created. are created.
""" """
import os import os
import sys import sys