diff mbox series

[bug#61972] services: dict: Deprecate 'dicod-service' procedure.

Message ID 8743d00e54840d6afde42b5080f9c19bfcdde96a.1677977220.git.mirai@makinata.eu
State New
Headers show
Series [bug#61972] services: dict: Deprecate 'dicod-service' procedure. | expand

Commit Message

Bruno Victal March 5, 2023, 12:48 a.m. UTC 
* 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(-)

Comments

Simon Tournier March 8, 2023, 9:56 a.m. UTC | #1 
Hi,

Thank you for your work about cleaning up.

On Sun, 05 Mar 2023 at 00:48, Bruno Victal <mirai@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
Ludovic Courtès March 17, 2023, 10:16 p.m. UTC | #2 
Hi,

Bruno Victal <mirai@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’.
diff mbox series

Patch

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}).