From b520e909e09615b73e09bd43a3b6e03c5cec0af3 Mon Sep 17 00:00:00 2001 From: Chris Evich Date: Mon, 6 May 2024 13:26:50 -0400 Subject: [PATCH] CI Docs: Clarify passthrough_envars() comments A long time ago, `passthrough_envars()` was defined in `lib.sh`. It has since been moved, but the related comments were never updated. Update the env. var. comments pointing future maintainers to the function that relies on them. Otherwise a simple search w/in this repo. won't turn up anything. Signed-off-by: Chris Evich --- contrib/cirrus/lib.sh | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/contrib/cirrus/lib.sh b/contrib/cirrus/lib.sh index 0fa72e20ec..ec7104c827 100644 --- a/contrib/cirrus/lib.sh +++ b/contrib/cirrus/lib.sh @@ -89,18 +89,19 @@ fi # The starting place for linting and code validation EPOCH_TEST_COMMIT="$CIRRUS_BASE_SHA" -# Regex defining all CI-related env. vars. necessary for all possible -# testing operations on all platforms and versions. This is necessary -# to avoid needlessly passing through global/system values across -# contexts, such as host->container or root->rootless user +# The next three values define regular expressions matching env. vars. necessary +# for all possible testing contexts (rootless, container, etc.). These values +# are consumed by the passthrough_envars() automation library function. # # List of envariables which must be EXACT matches PASSTHROUGH_ENV_EXACT='CGROUP_MANAGER|DEST_BRANCH|DISTRO_NV|GOCACHE|GOPATH|GOSRC|NETWORK_BACKEND|OCI_RUNTIME|PODMAN_IGNORE_CGROUPSV1_WARNING|ROOTLESS_USER|SCRIPT_BASE|SKIP_USERNS|EC2_INST_TYPE|PODMAN_DB|STORAGE_FS' # List of envariable patterns which must match AT THE BEGINNING of the name. +# Consumed by the passthrough_envars() automation library function. PASSTHROUGH_ENV_ATSTART='CI|LANG|LC_|TEST' -# List of envariable patterns which can match ANYWHERE in the name +# List of envariable patterns which can match ANYWHERE in the name. +# Consumed by the passthrough_envars() automation library function. PASSTHROUGH_ENV_ANYWHERE='_NAME|_FQIN' # Unsafe env. vars for display