Changeset 99502 in vbox

Timestamp:

Apr 21, 2023 1:33:36 PM (20 months ago)

Author:

vboxsync

Message:

Additions/linux/installer: Added some docs. bugref:10359

File:

• trunk/src/VBox/Additions/linux/installer/vboxadd.sh (modified) (18 diffs)

trunk/src/VBox/Additions/linux/installer/vboxadd.sh

@@ -156 +156 @@
 [ "$VBOX_REVISION" != "r" ] || VBOX_REVISION='unknown'
 
+# Returns if the vboxguest module is running or not.
+#
+# Returns true if vboxguest module is running, false if not.
 running_vboxguest()
 {
@@ -161 +164 @@
 }
 
+# Returns if the vboxadd module is running or not.
+#
+# Returns true if vboxadd module is running, false if not.
 running_vboxadd()
 {
@@ -166 +172 @@
 }
 
+# Returns if the vboxsf module is running or not.
+#
+# Returns true if vboxsf module is running, false if not.
 running_vboxsf()
 {
@@ -171 +180 @@
 }
 
+# Returns if the vboxvideo module is running or not.
+#
+# Returns true if vboxvideo module is running, false if not.
 running_vboxvideo()
 {
@@ -176 +188 @@
 }
 
+# Returns if a specific module is running or not.
+#
+# Input $1: Module name to check running status for.
+#
+# Returns true if the module is running, false if not.
 running_module()
 {
@@ -181 +198 @@
 }
 
-# Get version string of currently running kernel module.
+# Returns the version string of a currently running kernel module.
+#
+# Input $1: Module name to check.
+#
+# Returns the module version string if found, or none if not found.
 running_module_version()
 {
-    mod=$1
+    mod="$1"
     version_string_path="/sys/module/"$mod"/version"
 
@@ -195 +216 @@
 }
 
-# Check if currently loaded kernel module version matches to
-# current Guest Additions installed version and revision.
+# Checks if a loaded kernel module version matches to the currently installed Guest Additions version and revision.
+#
+# Input $1: Module name to check.
+#
+# Returns "1" if the module matches the installed Guest Additions, or none if not.
 check_running_module_version()
 {
@@ -215 +239 @@
 }
 
-## Did we install a systemd service?
+# Returns if we did install a service as a systemd service.
+#
+# Input $1: Service name to check.
+#
+# Returns true if the service is installed as a systemd service, false if not.
 systemd_service_installed()
 {
@@ -225 +253 @@
 }
 
-## Perform an action on a service
+## Performs an action on a service
 do_sysvinit_action()
 {
@@ -296 +324 @@
 }
 
-## Update the initramfs.  Debian and Ubuntu put the graphics driver in, and
+## Updates the initramfs.  Debian and Ubuntu put the graphics driver in, and
 # need the touch(1) command below.  Everyone else that I checked just need
 # the right module alias file from depmod(1) and only use the initramfs to
@@ -324 +352 @@
 }
 
-# Remove any existing VirtualBox guest kernel modules from the disk, but not
+# Removes any existing VirtualBox guest kernel modules from the disk, but not
 # from the kernel as they may still be in use
 cleanup_modules()
@@ -375 +403 @@
 esac
 
-# Check if update-secureboot-policy tool supports required commandline options.
+# Checks if update-secureboot-policy tool supports required commandline options.
 update_secureboot_policy_supports()
 {
@@ -659 +687 @@
 }
 
-# Returns path to module file as seen by modinfo(8) or empty string.
+# Returns path to a module file as seen by modinfo(8), or none if not found.
+#
+# Input $1: Module name to get path for.
+#
+# Returns the module path as a string.
 module_path()
 {
@@ -668 +700 @@
 }
 
-# Returns module version if module is available or empty string.
+# Returns module version if module is available, or none if not found.
+#
+# Input $1: Module name to get version for.
+#
+# Returns the module version as a string.
 module_version()
 {
@@ -677 +713 @@
 }
 
-# Returns module revision if module is available in the system or empty string.
+# Returns the module revision if module is available in the system, or none if not found.
+#
+# Input $1: Module name to get revision for.
+#
+# Returns the module revision as a string.
 module_revision()
 {
@@ -686 +726 @@
 }
 
+# Checks if a given kernel module is properly signed or not.
+#
+# Input $1: Module name to check.
+#
 # Returns "1" if module is signed and signature can be verified
-# with public key provided in DEB_PUB_KEY. Or empty string otherwise.
+# with public key provided in DEB_PUB_KEY, or none otherwise.
 module_signed()
 {
@@ -743 +787 @@
 }
 
+# Checks if a given kernel module matches the installed VirtualBox Guest Additions version.
+#
+# Input $1: Module name to check.
+#
 # Returns "1" if externally built module is available in the system and its
 # version and revision number do match to current VirtualBox installation.
-# Or empty string otherwise.
+# None otherwise.
 module_available()
 {
@@ -781 +829 @@
 
 # Check if required modules are installed in the system and versions match.
+#
+# Returns "1" on success, none otherwise.
 setup_complete()
 {