JDM170/build
1
0
Fork 0
mirror of https://github.com/armbian/build synced 2025-09-24 19:47:06 +07:00
Code Issues Packages Projects Releases Wiki Activity

📝 Add docstrings to rgblogo

Browse Source 
Docstrings generation was requested by @igorpecovnik.

* https://github.com/armbian/build/pull/8018#issuecomment-2761030989

The following files were modified:

* `lib/functions/configuration/main-config.sh`
This commit is contained in:
coderabbitai[bot]
2025-03-28 11:36:20 +00:00
committed by GitHub
parent 429e384137
commit 2529a8662e
1 changed files with 33 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
lib/functions/configuration/main-config.sh
View File

@@ -7,7 +7,39 @@
# This file is a part of the Armbian Build Framework
# https://github.com/armbian/build/
### Attention: we can't use any interactive programs, read from stdin, nor use non-coreutils utilities here.
# Initializes the main build configuration for generating Armbian images.
#
# This function sets up core environment variables, applies defaults for branding,
# network configuration, filesystem support, timezone settings, and build options.
# It determines the build revision from user or main version files, validates critical
# settings (e.g., ensuring the revision starts with a digit and that mandatory
# encryption parameters are defined when needed), and marks key variables as read-only.
# The function also invokes extension hooks for family- and branch-specific configuration.
#
# Globals:
# MOUNT_UUID - Identifier used in alert messages.
# REVISION - Build revision derived from version files; made read-only.
# VENDOR - Build image vendor, defaulting to "Armbian-unofficial" if unset.
# VENDORURL, VENDORSUPPORT, VENDORPRIVACY, VENDORBUGS, VENDORLOGO
# - Settings for image branding and support links.
# ROOTPWD, MAINTAINER, MAINTAINERMAIL
# - Default credentials and maintainer details.
# DEST_LANG - Target locale for the image, defaulting to "en_US.UTF-8".
# SKIP_EXTERNAL_TOOLCHAINS, USE_CCACHE
# - Build toolchain and caching options.
# NETWORKING_STACK - Selected networking configuration, inferred based on BUILD_MINIMAL.
# TZDATA - Timezone info taken from /etc/timezone or defaulted to "Etc/UTC".
# CHROOT_CACHE_VERSION - Version for chroot cache management.
# DEB_COMPRESS - Compression method for .deb packages, adjusted for CI environments.
#
# Outputs:
# Displays progress and debug alerts to STDOUT/STDERR and exits on configuration errors.
#
# Returns:
# None. Exits the script if critical configuration validations fail.
#
# Example:
# do_main_configuration
function do_main_configuration() {
display_alert "Starting main configuration" "${MOUNT_UUID}" "info"