diff options
author | Runciter | 2025-04-27 23:08:10 +0800 |
---|---|---|
committer | Runciter | 2025-04-27 23:08:10 +0800 |
commit | f185a299a61a5d88c48869a6801545ed59fef59a (patch) | |
tree | 9462a4bd5877f2ff81277228f80d1000ba37ec0f | |
parent | 2a76cd88aa9f2ee182ec059870fde832bf182d33 (diff) | |
download | whispers-doc-f185a299a61a5d88c48869a6801545ed59fef59a.tar.gz |
Update info manual to reflect new working log rotation.
M doc/whispers.texi
Remove mentions of the silent failure of previous rottlog attemps
Document the log-rotation? member of whispers-configuration records
Add mention of rotation under /var/log/whispers in the Purpose section
-rw-r--r-- | doc/whispers.texi | 21 |
1 files changed, 8 insertions, 13 deletions
diff --git a/doc/whispers.texi b/doc/whispers.texi index 8e44f2a..c527900 100644 --- a/doc/whispers.texi +++ b/doc/whispers.texi @@ -150,7 +150,9 @@ directory. Log files of the whispers hierarchy and its shepherd services are all stored under the path @code{/var/log/whispers}, with a sub-directory -tree mimicking the hierarchy in its current and past states. +tree mimicking the hierarchy in its current and past states. All log +files should be rotated by default through their respective hierarchy +Shepherd's @code{log-rotation} service. Various Scheme sub-modules of @code{(whispers packages whispers)} provide Guix services that deploy daemons running inside the whispers @@ -196,6 +198,11 @@ superior or PID 1. A list of Guix service objects. The lieutenants of this whispers service. +@item @code{log-rotation?} (default @code{#t}) +A boolean value. Whether this shepherd's @code{log-rotation} service +should be activated. At the time of writing, only a default +configuration of the rotation service is supported. + @item @code{requires} (default @code{'()}) A list of symbols. The list of shepherd provisions that this service requires in its superior or PID 1, a.k.a its dependencies. @@ -262,9 +269,6 @@ Services,,,Guix,GNU guix}): @table @code -@item rottlog-service-type -@xref{Log Rotation,,,Guix,GNU guix}. - @item account-service-type @item shepherd-root-service-type @@ -294,12 +298,6 @@ down the extension graph by whisper's own extensions of other Guix services at system-reconfiguration time, as if they were direct Guix service extensions. -The same functionality is intended and included in the code for services -of the service tree which have a @code{service-extension} targeting the -service of type @code{rottlog-service-type}. At the time of writing, it -does not seems to be working, no log rotation happens inside the path -@code{/var/log/whispers}. - Other service extensions of services within the whispers service tree should be silently ignored. @@ -1291,9 +1289,6 @@ updated configuration. @node Bugs, GNU Free Documentation License, Caveats, Top @chapter Bugs -Log rotation is not working in @code{/var/log/whispers}. As of writing, -the cause of this bug is unknown. - @node GNU Free Documentation License, Concept Index, Bugs, Top @appendix GNU Free Documentation License @cindex license, GNU Free Documentation License |