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:
@@ -33,6 +33,25 @@
|
||||
# --delete behaviour automatically. No manual cleanup needed.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# DESIGN PRINCIPLES
|
||||
# ==============================================================================================
|
||||
#
|
||||
# The .cfg Files Are the Source of Truth
|
||||
# Directories are recreated from /boot/config/shares/*.cfg rather than from a list in
|
||||
# Varaverk's conf. Those files are Unraid's own record of what a share is and which disks
|
||||
# it spans — anything Varaverk maintained separately would be a second copy free to drift.
|
||||
#
|
||||
# Create Only, Never Delete
|
||||
# Missing directories are created and existing ones left alone. This runs after a rebuild,
|
||||
# when the operator's mental model of what should exist may be out of date; removing
|
||||
# anything on that basis is how a recovery step becomes a data loss step.
|
||||
#
|
||||
# Array Must Be Started
|
||||
# Refuses to run without /mnt/user mounted. Creating share directories against an
|
||||
# unmounted array writes them into the underlying root filesystem, which then shadows the
|
||||
# real shares once the array does mount.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# OPERATIONAL SAFEGUARDS
|
||||
# ==============================================================================================
|
||||
#
|
||||
@@ -58,6 +77,22 @@
|
||||
# platform_require_cmd confirms the notify script is present before use.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# CONFIGURATION
|
||||
# ==============================================================================================
|
||||
#
|
||||
# No Varaverk config vars. Everything is read from Unraid's own share definitions:
|
||||
#
|
||||
# /boot/config/shares/*.cfg
|
||||
# One file per share. shareInclude names the disks the share spans; the directory is
|
||||
# created on each of them. A share with no shareInclude spans all array disks.
|
||||
#
|
||||
# /mnt/user
|
||||
# Must be mounted — see Array Must Be Started above.
|
||||
#
|
||||
# Deliberately not driven by HOST*_*_SYNC_SHARES: this recreates every share the server
|
||||
# knows about, not only the ones Varaverk syncs.
|
||||
#
|
||||
# ==============================================================================================
|
||||
# RUNTIME MODES
|
||||
# ==============================================================================================
|
||||
#
|
||||
|
||||
Reference in New Issue
Block a user