GNU bug report logs - #61972
[PATCH] services: dict: Deprecate 'dicod-service' procedure.

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 61972 in the body.
You can then email your comments to 61972 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Bruno Victal <mirai <at> makinata.eu>
To: guix-patches <at> gnu.org
Cc: Bruno Victal <mirai <at> makinata.eu>
Subject: [PATCH] services: dict: Deprecate 'dicod-service' procedure.
Date: Sun,  5 Mar 2023 00:48:23 +0000

* doc/guix.texi (Miscellaneous Services): Remove 'dicod-service' mention.
* gnu/services/dict.scm (dicod-service): Deprecate procedure.
---
 doc/guix.texi         | 48 +++++++++++++++++++------------------------
 gnu/services/dict.scm |  6 ++++--
 2 files changed, 25 insertions(+), 29 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 74658dbc86..98a8b42fcf 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -37826,27 +37826,19 @@ Miscellaneous Services
 @end table
 @end deftp
 
-@subsubheading Dictionary Service
 @cindex dictionary
+@subsubheading Dictionary Service
+
 The @code{(gnu services dict)} module provides the following service:
 
 @defvar dicod-service-type
 This is the type of the service that runs the @command{dicod} daemon, an
 implementation of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}).
-@end defvar
-
-@deffn {Scheme Procedure} dicod-service [#:config (dicod-configuration)]
-Return a service that runs the @command{dicod} daemon, an implementation
-of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}).
-
-The optional @var{config} argument specifies the configuration for
-@command{dicod}, which should be a @code{<dicod-configuration>} object, by
-default it serves the GNU Collaborative International Dictionary of English.
 
 You can add @command{open localhost} to your @file{~/.dico} file to make
 @code{localhost} the default server for @command{dico} client
 (@pxref{Initialization File,,, dico, GNU Dico Manual}).
-@end deffn
+@end defvar
 
 @deftp {Data Type} dicod-configuration
 Data type representing the configuration of dicod.
@@ -37911,22 +37903,24 @@ Miscellaneous Services
 Dictionary of English using the @code{gcide} package.
 @end defvar
 
-The following is an example @code{dicod-service} configuration.
-
-@lisp
-(dicod-service #:config
-  (dicod-configuration
-   (handlers (list (dicod-handler
-                    (name "wordnet")
-                    (module "dictorg")
-                    (options
-                     (list #~(string-append "dbdir=" #$wordnet))))))
-   (databases (list (dicod-database
-                     (name "wordnet")
-                     (complex? #t)
-                     (handler "wordnet")
-                     (options '("database=wn")))
-                    %dicod-database:gcide))))
+The following is an example @code{dicod-service-type} configuration.
+
+@lisp
+(service dicod-service-type
+         (dicod-configuration
+          (handlers (list
+                     (dicod-handler
+                      (name "wordnet")
+                      (module "dictorg")
+                      (options
+                       (list #~(string-append "dbdir=" #$wordnet))))))
+          (databases (list
+                      (dicod-database
+                       (name "wordnet")
+                       (complex? #t)
+                       (handler "wordnet")
+                       (options '("database=wn")))
+                      %dicod-database:gcide))))
 @end lisp
 
 @cindex Docker
diff --git a/gnu/services/dict.scm b/gnu/services/dict.scm
index 35253a0077..5a61085316 100644
--- a/gnu/services/dict.scm
+++ b/gnu/services/dict.scm
@@ -19,6 +19,7 @@
 ;;; along with GNU Guix.  If not, see <http://www.gnu.org/licenses/>.
 
 (define-module (gnu services dict)
+  #:use-module (guix deprecation)
   #:use-module (guix gexp)
   #:use-module (guix records)
   #:use-module (guix modules)
@@ -34,7 +35,7 @@ (define-module (gnu services dict)
   #:use-module (srfi srfi-1)
   #:use-module (srfi srfi-26)
   #:use-module (ice-9 match)
-  #:export (dicod-service
+  #:export (dicod-service  ; deprecated
             dicod-service-type
             dicod-configuration
             dicod-handler
@@ -202,7 +203,8 @@ (define dicod-service-type
 implements the standard DICT protocol supported by clients such as
 @command{dico} and GNOME Dictionary.")))
 
-(define* (dicod-service #:key (config (dicod-configuration)))
+(define-deprecated (dicod-service #:key (config (dicod-configuration)))
+  dicod-service-type
   "Return a service that runs the @command{dicod} daemon, an implementation
 of DICT server (@pxref{Dicod,,, dico, GNU Dico Manual}).
 
-- 
2.39.1

Message #8 received at 61972 <at> debbugs.gnu.org (full text, mbox):

From: Simon Tournier <zimon.toutoune <at> gmail.com>
To: Bruno Victal <mirai <at> makinata.eu>, 61972 <at> debbugs.gnu.org
Cc: ludo <at> gnu.org, Bruno Victal <mirai <at> makinata.eu>
Subject: Re: [bug#61972] [PATCH] services: dict: Deprecate 'dicod-service'
 procedure.
Date: Wed, 08 Mar 2023 10:56:44 +0100

Hi,

Thank you for your work about cleaning up.

On Sun, 05 Mar 2023 at 00:48, Bruno Victal <mirai <at> makinata.eu> wrote:
> * doc/guix.texi (Miscellaneous Services): Remove 'dicod-service' mention.
> * gnu/services/dict.scm (dicod-service): Deprecate procedure.
> ---
>  doc/guix.texi         | 48 +++++++++++++++++++------------------------
>  gnu/services/dict.scm |  6 ++++--
>  2 files changed, 25 insertions(+), 29 deletions(-)

LGTM.

Cheers,
simon

Message #13 received at 61972-done <at> debbugs.gnu.org (full text, mbox):

From: Ludovic Courtès <ludo <at> gnu.org>
To: Bruno Victal <mirai <at> makinata.eu>
Cc: 61972-done <at> debbugs.gnu.org
Subject: Re: bug#61972: [PATCH] services: dict: Deprecate 'dicod-service'
 procedure.
Date: Fri, 17 Mar 2023 23:16:10 +0100

Hi,

Bruno Victal <mirai <at> makinata.eu> skribis:

> * doc/guix.texi (Miscellaneous Services): Remove 'dicod-service' mention.
> * gnu/services/dict.scm (dicod-service): Deprecate procedure.

Applied!

> -@subsubheading Dictionary Service
>  @cindex dictionary
> +@subsubheading Dictionary Service

… except for this hunk: the anchor must be within the section, not
before it.

Thanks,
Ludo’.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.