services: spice: Deprecate 'spice-vdagent-service' procedure.

* doc/guix.texi (Miscellaneous Services): Replace 'spice-vdagent-service' with
'spice-vdagent-service-type'. Document <spice-vdagent-configuration>.
* gnu/services/spice.scm (spice-vdagent-service): Deprecate procedure.

Signed-off-by: Ludovic Courtès <ludo@gnu.org>
This commit is contained in:
Bruno Victal 2023-02-25 18:58:11 +00:00 committed by Ludovic Courtès
parent e24555234a
commit 7c23dab85c
No known key found for this signature in database
GPG key ID: 090B11993D9AEBB5
2 changed files with 22 additions and 10 deletions

View file

@ -37759,16 +37759,27 @@ Additional command-line options to pass to @command{lircd}.
@c TODO: Document <lirc-configuration>, preferably by refactoring this to use
@c define-configuration and generating documentation from it.
@cindex spice
@subsubheading Spice Service
@cindex SPICE
@subsubheading SPICE Service
The @code{(gnu services spice)} module provides the following service.
@deffn {Scheme Procedure} spice-vdagent-service [#:spice-vdagent]
Returns a service that runs @url{https://www.spice-space.org,VDAGENT}, a daemon
that enables sharing the clipboard with a vm and setting the guest display
resolution when the graphical console window resizes.
@end deffn
@defvar spice-vdagent-service-type
Type of the service that runs @url{https://www.spice-space.org, VDAGENT},
a daemon that enables sharing the clipboard with a vm and setting the
guest display resolution when the graphical console window resizes.
@end defvar
@deftp {Data Type} spice-vdagent-configuration
Data type representing the configuration of
@code{spice-vdagent-service-type}.
@table @asis
@item @code{spice-vdagent} (default: @code{spice-vdagent}) (type: file-like)
Package object for VDAGENT.
@end table
@end deftp
@cindex inputattach
@subsubheading inputattach Service

View file

@ -21,12 +21,13 @@ (define-module (gnu services spice)
#:use-module (gnu packages spice)
#:use-module (gnu services)
#:use-module (gnu services shepherd)
#:use-module (guix deprecation)
#:use-module (guix gexp)
#:use-module (guix records)
#:export (spice-vdagent-configuration
spice-vdagent-configuration?
spice-vdagent-service-type
spice-vdagent-service))
spice-vdagent-service)) ; deprecated
(define-record-type* <spice-vdagent-configuration>
spice-vdagent-configuration make-spice-vdagent-configuration
@ -74,8 +75,8 @@ (define spice-vdagent-service-type
from the @code{spice-vdagent} package to enable window resizing and clipboard
sharing for @acronym{VM, virtual machine} guests.")))
(define* (spice-vdagent-service
#:optional (config (spice-vdagent-configuration)))
(define-deprecated (spice-vdagent-service
#:optional (config (spice-vdagent-configuration)))
"Start the @command{vdagentd} and @command{vdagent} daemons
from @var{spice-vdagent} to enable guest window resizing and
clipboard sharing."