Complete the header template across Partnership, Kernel, Deployment and Plugin

Finishes the pass: every script now documents its safeguards, and the deliberate absences
in the sourced libraries are recorded so they are not "corrected" later.
This commit is contained in:
Gmer4Lfe
2026-08-01 22:44:23 -04:00
parent 5c4f8db497
commit c377ddfcca
24 changed files with 1237 additions and 32 deletions
@@ -32,6 +32,25 @@
# tree mid-execution.
#
# ==============================================================================================
# DESIGN PRINCIPLES
# ==============================================================================================
#
# Name the Scripts, Not Just the PIDs
# Output resolves each process to the script it is running. "Stopping 4 processes" tells
# an operator nothing they can act on; "stopping mover_tuning, preclear" tells them
# exactly what they are about to lose and whether they should wait.
#
# Targeted, Never Blanket
# Only processes spawned by the User Scripts plugin are matched. A broad pattern would
# catch unrelated shells and Varaverk's own scripts — including, during a reboot sequence,
# the very script doing the stopping.
#
# Shutdown Step and Manual Tool, Same Behaviour
# Called automatically by server_reboot.sh and usable by hand on a stuck script. It takes
# no "reboot mode" — the correct action is identical either way, and a mode flag would be
# a second code path that only ever runs unattended.
#
# ==============================================================================================
# OPERATIONAL SAFEGUARDS
# ==============================================================================================
#
@@ -51,6 +70,21 @@
# No processes running = log() only, no visible output.
#
# ==============================================================================================
# CONFIGURATION
# ==============================================================================================
#
# No config vars. Targets are discovered from running processes rather than from a list,
# because the User Scripts plugin owns what exists and any list here would go stale.
#
# Platform-owned:
#
# The unRAID User Scripts plugin's script directory and the processes it spawns. Matching
# is scoped to those — see Targeted, Never Blanket above for why that matters during a
# reboot sequence.
#
# Called by server_reboot.sh as a shutdown step; also safe to run by hand.
#
# ==============================================================================================
# RUNTIME MODES
# ==============================================================================================
#