Skip to content

Commit 5c87528

Browse files
committed
Add Usage instructions to both scripts
Signed-off-by: Jonathan Dowland <[email protected]>
1 parent 5ab966d commit 5c87528

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

gendocs.py

+6
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@
33
# read in all the module YAML files specified for an image, in order, to
44
# produce a comprehensive list of configuration environment variables,
55
# then write them out to something useful
6+
#
7+
# Usage:
8+
# ./gendocs.py name-of-image > output-asciidoc-file
9+
#
10+
# This script reads target/image.yaml, which is produced by a cekit
11+
# build (including --dry-run)
612

713
import yaml
814
import sys

gendocs.sh

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ set -euo pipefail
55
# wish to generate documentation for, by switching to the relevant git
66
# branches and tags and enumerating the image descriptors.
77
# It is expected that this script is invoked via GitHub Actions.
8+
#
9+
# Usage: ./gendocs.sh
810

911
engine=${engine-podman}
1012

0 commit comments

Comments
 (0)