aboutsummaryrefslogtreecommitdiffstats
path: root/AGENTS.md
diff options
context:
space:
mode:
Diffstat (limited to 'AGENTS.md')
-rw-r--r--AGENTS.md9
1 files changed, 7 insertions, 2 deletions
diff --git a/AGENTS.md b/AGENTS.md
index 5024c4d..723408e 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -11,6 +11,10 @@ Run all of these before calling a change done:
./dist-upgrade --self-test
shellcheck --exclude=SC2218 dist-upgrade
+If `logrotate` is available, the shipped rule can be checked with:
+
+ logrotate -d logrotate.d/dist-upgrade
+
SC2218 is a shellcheck 0.11.0 false positive: it flags a function called on the
left of a pipe inside another function definition (`b() { a | cat; }`), even
when `a` is defined above. Keep it excluded; do not restructure the pipeline to
@@ -21,8 +25,9 @@ silence it.
- Do not run the script itself, or any `slackpkg` command, in this repo. It
performs a real system upgrade and only makes sense on the user's Slackware
box as root.
-- Do not add config, cache or log files. The script is self-contained and
- configured through the `INITRD` environment variable.
+- Do not add runtime config, cache or log files. The script is self-contained
+ and configured through the `INITRD` and `LOG` environment variables; the only
+ config it ships is `logrotate.d/dist-upgrade`.
## Conventions