diff options
| author | Ophestra <cat@gensokyo.uk> | 2026-02-28 20:18:30 +0900 |
|---|---|---|
| committer | Ophestra <cat@gensokyo.uk> | 2026-02-28 20:18:30 +0900 |
| commit | cd9b534d6b1d432d3c997ccc5b14f630afb9dda6 (patch) | |
| tree | fcf2e26356d614bb081e94285a1a8eb19cb8283c /container/fhs/fhs.go | |
| parent | 84e6922f3073ec09756df6075a801529ecd202f6 (diff) | |
container: improve documentation
This change removes inconsistencies collected over time in this package.
Signed-off-by: Ophestra <cat@gensokyo.uk>
Diffstat (limited to 'container/fhs/fhs.go')
| -rw-r--r-- | container/fhs/fhs.go | 21 |
1 files changed, 14 insertions, 7 deletions
diff --git a/container/fhs/fhs.go b/container/fhs/fhs.go index 7e0d36c7..e0c1d861 100644 --- a/container/fhs/fhs.go +++ b/container/fhs/fhs.go @@ -9,7 +9,8 @@ const ( // Tmp points to the place for small temporary files. Tmp = "/tmp/" - // Run points to a "tmpfs" file system for system packages to place runtime data, socket files, and similar. + // Run points to a "tmpfs" file system for system packages to place runtime + // data, socket files, and similar. Run = "/run/" // RunUser points to a directory containing per-user runtime directories, // each usually individually mounted "tmpfs" instances. @@ -17,10 +18,12 @@ const ( // Usr points to vendor-supplied operating system resources. Usr = "/usr/" - // UsrBin points to binaries and executables for user commands that shall appear in the $PATH search path. + // UsrBin points to binaries and executables for user commands that shall + // appear in the $PATH search path. UsrBin = Usr + "bin/" - // Var points to persistent, variable system data. Writable during normal system operation. + // Var points to persistent, variable system data. Writable during normal + // system operation. Var = "/var/" // VarLib points to persistent system data. VarLib = Var + "lib/" @@ -29,12 +32,16 @@ const ( // Dev points to the root directory for device nodes. Dev = "/dev/" - // DevShm is the place for POSIX shared memory segments, as created via shm_open(3). + // DevShm is the place for POSIX shared memory segments, as created via + // shm_open(3). DevShm = "/dev/shm/" - // Proc points to a virtual kernel file system exposing the process list and other functionality. + // Proc points to a virtual kernel file system exposing the process list and + // other functionality. Proc = "/proc/" - // ProcSys points to a hierarchy below /proc/ that exposes a number of kernel tunables. + // ProcSys points to a hierarchy below /proc/ that exposes a number of + // kernel tunables. ProcSys = Proc + "sys/" - // Sys points to a virtual kernel file system exposing discovered devices and other functionality. + // Sys points to a virtual kernel file system exposing discovered devices + // and other functionality. Sys = "/sys/" ) |