From cbf1024e9907c7402e66c0c225dba7406fbd82e8 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Ludovic=20Court=C3=A8s?= <ludo@gnu.org>
Date: Thu, 24 Nov 2016 21:53:57 +0100
Subject: [PATCH] doc: Document 'wpa-supplicant-service-type'.
Reported by Chris Marusich <cmmarusich@gmail.com>.
* doc/guix.texi (Networking Services): Remove 'wpa-supplicant-service'
procedure, which doesn't exist, and document
'wpa-supplicant-service-type'.
---
doc/guix.texi | 19 ++++++++++++++-----
1 file changed, 14 insertions(+), 5 deletions(-)
diff --git a/doc/guix.texi b/doc/guix.texi
index 0055d094e8f..4d9c107a9c9 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -8431,13 +8431,22 @@ configure networking."
@end deffn
@cindex WPA Supplicant
-@deffn {Scheme Procedure} wpa-supplicant-service @
- [#:wpa-supplicant @var{wpa-supplicant}]
-Return a service that runs @url{https://w1.fi/wpa_supplicant/,WPA
+@defvr {Scheme Variable} wpa-supplicant-service-type
+This is the service type to run @url{https://w1.fi/wpa_supplicant/,WPA
supplicant}, an authentication daemon required to authenticate against
-encrypted WiFi or ethernet networks. Service is started to listen for
+encrypted WiFi or ethernet networks. It is configured to listen for
requests on D-Bus.
-@end deffn
+
+The value of this service is the @code{wpa-supplicant} package to use.
+Thus, it can be instantiated like this:
+
+@lisp
+(use-modules (gnu services networking)
+ (gnu packages admin))
+
+(service wpa-supplicant-type wpa-supplicant)
+@end lisp
+@end defvr
@cindex NTP
@cindex real time clock
--
GitLab