diff mbox series

[bug#74860,v3,07/12] services: rottlog: Deprecate.

Message ID 0bc8156ace914dd7e1b8f8a5c7741d8b5af7b8fe.1736373023.git.ludo@gnu.org
State New
Headers
Series Using the Shepherd's log rotation service |

Commit Message

Ludovic Courtès Jan. 8, 2025, 9:51 p.m. UTC 
  * gnu/services/admin.scm (rottlog-service-type): Deprecate.
* doc/guix.texi (Log Rotation): Add deprecation warning.

Change-Id: I661666ff3de64a69ff4f4982d7f432fd575c36df
---
 doc/guix.texi          | 7 +++++++
 gnu/services/admin.scm | 9 +++++++--
 2 files changed, 14 insertions(+), 2 deletions(-)
diff mbox series

Patch

diff --git a/doc/guix.texi b/doc/guix.texi
index 0e8945be16..7bc1d0b9e5 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -20952,6 +20952,13 @@  Log Rotation
 rotation tool (@pxref{Top,,, rottlog, GNU Rot[t]log Manual}), is also
 provided.
 
+@quotation Warning
+The Rottlog service presented here is deprecated in favor of
+@code{log-rotation-service-type} (see above).  The
+@code{rottlog-service-type} variable and related tools will be removed
+after 2025-06-15.
+@end quotation
+
 The example below shows how to extend it with an additional
 @dfn{rotation}, should you need to do that (usually, services that
 produce log files already take care of that):
diff --git a/gnu/services/admin.scm b/gnu/services/admin.scm
index f3331ae835..54a22d98dc 100644
--- a/gnu/services/admin.scm
+++ b/gnu/services/admin.scm
@@ -38,6 +38,7 @@  (define-module (gnu services admin)
   #:use-module (gnu system accounts)
   #:use-module ((gnu system shadow) #:select (account-service-type))
   #:use-module ((guix store) #:select (%store-prefix))
+  #:use-module (guix deprecation)
   #:use-module (guix gexp)
   #:use-module (guix modules)
   #:use-module (guix packages)
@@ -334,12 +335,16 @@  (define (rottlog-jobs-or-default config)
   (or (rottlog-configuration-jobs config)
       (default-jobs (rottlog-configuration-rottlog config))))
 
-(define rottlog-service-type
+;; TODO: Deprecated; remove sometime after 2025-06-15.
+(define-deprecated rottlog-service-type
+  log-rotation-service-type
   (service-type
    (name 'rottlog)
    (description
     "Periodically rotate log files using GNU@tie{}Rottlog and GNU@tie{}mcron.
-Old log files are removed or compressed according to the configuration.")
+Old log files are removed or compressed according to the configuration.
+
+This service is deprecated and slated for removal after 2025-06-15.")
    (extensions (list (service-extension etc-service-type rottlog-etc)
                      (service-extension mcron-service-type
                                         rottlog-jobs-or-default)