stages: consistent docstrings
Make docstrings consistent across stages regarding whitespace and summary line.
This commit is contained in:
parent
352bf5cd52
commit
02b6d696ef
13 changed files with 15 additions and 11 deletions
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
|
|
@ -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:
|
||||
|
|
|
|||
|
|
@ -2,7 +2,6 @@
|
|||
"""
|
||||
Create a boot filesystem tree, can be consumed to create
|
||||
an efiboot.img.
|
||||
|
||||
"""
|
||||
|
||||
import os
|
||||
|
|
|
|||
|
|
@ -1,7 +1,6 @@
|
|||
#!/usr/bin/python3
|
||||
"""
|
||||
Create an isolinux bootloader
|
||||
|
||||
"""
|
||||
|
||||
import os
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
#!/usr/bin/python3
|
||||
"""
|
||||
configure pacman
|
||||
Configure pacman
|
||||
"""
|
||||
import os
|
||||
import sys
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
#!/usr/bin/python3
|
||||
"""
|
||||
configure pacman's mirrorlist
|
||||
Configure pacman's mirrorlist
|
||||
"""
|
||||
import os
|
||||
import pathlib
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue