From 75fd6af2e769fd52889b74c91dc3fc48a25ff46a Mon Sep 17 00:00:00 2001
From: "coderabbitai[bot]"
 <136622811+coderabbitai[bot]@users.noreply.github.com>
Date: Mon, 24 Mar 2025 00:14:49 +0000
Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Add=20docstrings=20to=20`main`?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

Docstrings generation was requested by @rpardini.

* https://github.com/armbian/build/pull/7982#issuecomment-2746385084

The following files were modified:

* `lib/functions/bsp/armbian-bsp-cli-deb.sh`
---
 lib/functions/bsp/armbian-bsp-cli-deb.sh | 24 +++++++++++++++++++++++-
 1 file changed, 23 insertions(+), 1 deletion(-)

diff --git a/lib/functions/bsp/armbian-bsp-cli-deb.sh b/lib/functions/bsp/armbian-bsp-cli-deb.sh
index 32538d6b4..b499e5a73 100644
--- a/lib/functions/bsp/armbian-bsp-cli-deb.sh
+++ b/lib/functions/bsp/armbian-bsp-cli-deb.sh
@@ -250,7 +250,29 @@ function compile_armbian-bsp-cli() {
 }
 
 # Reversion function is called with the following parameters:
-# ${1} == deb_id
+# Updates control file metadata and version information for the armbian-bsp-cli Debian package reversion.
+#
+# Globals:
+#   REVISION - The target package version/revision used in control file entries.
+#   control_file_new - The file to which package metadata is appended.
+#   data_dir - Directory containing package data; must be set.
+#   KEEP_ORIGINAL_OS_RELEASE - Flag determining whether to include base-files dependency.
+#   SHOW_DEBUG - If "yes", enables output of debug information.
+#   BOARD, EXTRA_BSP_NAME - Identifiers used to form package names in metadata.
+#
+# Arguments:
+#   $1 - Package identifier; the function proceeds only if this equals "armbian-bsp-cli".
+#
+# Outputs:
+#   Appends dependency, replacement, breaking, and provides fields to the package control file.
+#   Updates the armbian-release file with the current VERSION and REVISION.
+#   Optionally displays the updated release file if debug output is enabled.
+#
+# Returns:
+#   0 on success or if the package identifier does not match "armbian-bsp-cli".
+#
+# Example:
+#   reversion_armbian-bsp-cli_deb_contents "armbian-bsp-cli"
 function reversion_armbian-bsp-cli_deb_contents() {
 	if [[ "${1}" != "armbian-bsp-cli" ]]; then
 		return 0 # Not our deb, nothing to do.