From patchwork Sat Jan 7 19:41:13 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Bruno Victal X-Patchwork-Id: 8915 Return-Path: X-Original-To: patchwork@mira.cbaines.net Delivered-To: patchwork@mira.cbaines.net Received: by mira.cbaines.net (Postfix, from userid 113) id DDB6627BBEB; Sat, 7 Jan 2023 19:42:17 +0000 (GMT) X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-3.9 required=5.0 tests=BAYES_00,MAILING_LIST_MULTI, RCVD_IN_MSPIKE_H2,SPF_HELO_PASS,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.6 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 6FE8427BBE9 for ; Sat, 7 Jan 2023 19:42:15 +0000 (GMT) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1pEF4u-0007TD-Pb; Sat, 07 Jan 2023 14:42:04 -0500 Received: from eggs.gnu.org ([2001:470:142:3::10]) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1pEF4t-0007Sm-Bl for guix-patches@gnu.org; Sat, 07 Jan 2023 14:42:03 -0500 Received: from debbugs.gnu.org ([209.51.188.43]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1pEF4r-0006Z0-Tb for guix-patches@gnu.org; Sat, 07 Jan 2023 14:42:03 -0500 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1pEF4r-0005ye-PO for guix-patches@gnu.org; Sat, 07 Jan 2023 14:42:01 -0500 X-Loop: help-debbugs@gnu.org Subject: [bug#60634] [PATCH 1/3] doc: Fix incorrect use of @defvar. Resent-From: Bruno Victal Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Sat, 07 Jan 2023 19:42:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 60634 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 60634@debbugs.gnu.org Cc: Bruno Victal Received: via spool by 60634-submit@debbugs.gnu.org id=B60634.167312050022946 (code B ref 60634); Sat, 07 Jan 2023 19:42:01 +0000 Received: (at 60634) by debbugs.gnu.org; 7 Jan 2023 19:41:40 +0000 Received: from localhost ([127.0.0.1]:59027 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pEF4V-0005y2-VS for submit@debbugs.gnu.org; Sat, 07 Jan 2023 14:41:40 -0500 Received: from smtpmciv7.myservices.hosting ([185.26.106.202]:46126) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1pEF4T-0005xt-Lc for 60634@debbugs.gnu.org; Sat, 07 Jan 2023 14:41:38 -0500 Received: from mail1.netim.hosting (unknown [185.26.106.172]) by smtpmciv7.myservices.hosting (Postfix) with ESMTP id BC6EF20C89 for <60634@debbugs.gnu.org>; Sat, 7 Jan 2023 20:41:36 +0100 (CET) Received: from localhost (localhost [127.0.0.1]) by mail1.netim.hosting (Postfix) with ESMTP id 4F55A80096; Sat, 7 Jan 2023 20:41:36 +0100 (CET) X-Virus-Scanned: Debian amavisd-new at mail1.netim.hosting Received: from mail1.netim.hosting ([127.0.0.1]) by localhost (mail1-1.netim.hosting [127.0.0.1]) (amavisd-new, port 10026) with ESMTP id 2fGPIm4cspQZ; Sat, 7 Jan 2023 20:41:32 +0100 (CET) Received: from guix-nuc.home.arpa (bl9-118-236.dsl.telepac.pt [85.242.118.236]) (Authenticated sender: lumen@makinata.eu) by mail1.netim.hosting (Postfix) with ESMTPSA id 6172080093; Sat, 7 Jan 2023 20:41:32 +0100 (CET) From: Bruno Victal Date: Sat, 7 Jan 2023 19:41:13 +0000 Message-Id: <2294b578df97f9160a6a365664cbd01800f64a52.1673119748.git.mirai@makinata.eu> X-Mailer: git-send-email 2.38.1 In-Reply-To: References: MIME-Version: 1.0 X-BeenThere: debbugs-submit@debbugs.gnu.org X-Mailman-Version: 2.1.18 Precedence: list X-BeenThere: guix-patches@gnu.org List-Id: List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org Sender: guix-patches-bounces+patchwork=mira.cbaines.net@gnu.org X-getmail-retrieved-from-mailbox: Patches * doc/guix.texi (Monitoring Services) (VNC Services) (Samba Services) (Game Services) (PAM Mount Service) (Guix Services): Fix incorrect use of @defvar. --- doc/guix.texi | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 293c3016aa..7a86501e60 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -28123,7 +28123,7 @@ Monitoring Services Darkstat is a packet sniffer that captures network traffic, calculates statistics about usage, and serves reports over HTTP. -@defvar {Scheme Variable} darkstat-service-type +@defvar darkstat-service-type This is the service type for the @uref{https://unix4lyfe.org/darkstat/, darkstat} service, its value must be a @code{darkstat-configuration} record as in @@ -28168,7 +28168,7 @@ Monitoring Services This service should be deployed on all physical nodes and virtual machines, where monitoring these statistics is desirable. -@defvar {Scheme variable} prometheus-node-exporter-service-type +@defvar prometheus-node-exporter-service-type This is the service type for the @uref{https://github.com/prometheus/node_exporter/, prometheus-node-exporter} service, its value must be a @code{prometheus-node-exporter-configuration}. @@ -28213,7 +28213,7 @@ Monitoring Services data sources are supported, such as @ref{prometheus-node-exporter, Prometheus Node Exporter}). -@defvar {Scheme variable} zabbix-server-service-type +@defvar zabbix-server-service-type This is the service type for the Zabbix server service. Its value must be a @code{zabbix-server-configuration} record, shown below. @end defvar @@ -28299,7 +28299,7 @@ Monitoring Services @uref{https://www.zabbix.com/documentation/current/en/manual/config/items/userparameters, @dfn{user parameters}}. -@defvar {Scheme variable} zabbix-agent-service-type +@defvar zabbix-agent-service-type This is the service type for the Zabbix agent service. Its value must be a @code{zabbix-agent-configuration} record, shown below. @end defvar @@ -28376,7 +28376,7 @@ Monitoring Services extending the @ref{PHP-FPM} and @ref{NGINX} services with the configuration necessary for loading the Zabbix user interface. -@defvar {Scheme variable} zabbix-front-end-service-type +@defvar zabbix-front-end-service-type This is the service type for the Zabbix web frontend. Its value must be a @code{zabbix-front-end-configuration} record, shown below. @end defvar @@ -31396,7 +31396,7 @@ VNC Services can run on headless servers. The Xvnc implementations provided by the @code{tigervnc-server} and @code{turbovnc} aim to be fast and efficient. -@defvar {Scheme Variable} xvnc-service-type +@defvar xvnc-service-type The @code{xvnc-server-type} service can be configured via the @code{xvnc-configuration} record, documented below. A second virtual @@ -32098,7 +32098,7 @@ Samba Services hosts in an heterougenious network with different types of Computer systems. -@defvar {Scheme variable} samba-service-type +@defvar samba-service-type The service type to enable the samba services @code{samba}, @code{nmbd}, @code{smbd} and @code{winbindd}. By default this service type does not @@ -36266,7 +36266,7 @@ Game Services based tactical strategy game, with several single player campaigns, and multiplayer games (both networked and local). -@defvar {Scheme Variable} wesnothd-service-type +@defvar wesnothd-service-type Service type for the wesnothd service. Its value must be a @code{wesnothd-configuration} object. To run wesnothd in the default configuration, instantiate it as: @@ -36297,7 +36297,7 @@ PAM Mount Service users to mount volumes when they log in. It should be able to mount any volume format supported by the system. -@defvar {Scheme Variable} pam-mount-service-type +@defvar pam-mount-service-type Service type for PAM Mount support. @end defvar @@ -36392,7 +36392,7 @@ Guix Services Coordinator, but the Guix service uses a custom Guile script instead, to provide better integration with G-expressions used in the configuration. -@defvar {Scheme Variable} guix-build-coordinator-service-type +@defvar guix-build-coordinator-service-type Service type for the Guix Build Coordinator. Its value must be a @code{guix-build-coordinator-configuration} object. @end defvar @@ -36441,7 +36441,7 @@ Guix Services @end table @end deftp -@defvar {Scheme Variable} guix-build-coordinator-agent-service-type +@defvar guix-build-coordinator-agent-service-type Service type for a Guix Build Coordinator agent. Its value must be a @code{guix-build-coordinator-agent-configuration} object. @end defvar @@ -36567,7 +36567,7 @@ Guix Services that may be useful when building derivations contained within an instance of the Guix Data Service. -@defvar {Scheme Variable} guix-build-coordinator-queue-builds-service-type +@defvar guix-build-coordinator-queue-builds-service-type Service type for the guix-build-coordinator-queue-builds-from-guix-data-service script. Its value must be a @code{guix-build-coordinator-queue-builds-configuration} @@ -36620,7 +36620,7 @@ Guix Services The data is stored in a PostgreSQL database, and available through a web interface. -@defvar {Scheme Variable} guix-data-service-type +@defvar guix-data-service-type Service type for the Guix Data Service. Its value must be a @code{guix-data-service-configuration} object. The service optionally extends the getmail service, as the guix-commits mailing list is used to @@ -36668,7 +36668,7 @@ Guix Services The @uref{https://git.cbaines.net/guix/nar-herder/about/,Nar Herder} is a utility for managing a collection of nars. -@defvar {Scheme Variable} nar-herder-type +@defvar nar-herder-type Service type for the Guix Data Service. Its value must be a @code{nar-herder-configuration} object. The service optionally extends the getmail service, as the guix-commits mailing list is used to