From patchwork Wed Jun 9 13:06:26 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Xinglu Chen X-Patchwork-Id: 30077 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 74FC227BC83; Wed, 9 Jun 2021 14:07:11 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_PASS, T_DKIM_INVALID,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 1F90E27BC78 for ; Wed, 9 Jun 2021 14:07:11 +0100 (BST) Received: from localhost ([::1]:36836 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lqxvK-0000rU-7d for patchwork@mira.cbaines.net; Wed, 09 Jun 2021 09:07:10 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52604) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqxvC-0000r0-LM for guix-patches@gnu.org; Wed, 09 Jun 2021 09:07:02 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:49218) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lqxvC-0007Ut-Cj for guix-patches@gnu.org; Wed, 09 Jun 2021 09:07:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lqxvC-0002CQ-9d for guix-patches@gnu.org; Wed, 09 Jun 2021 09:07:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#48934] [PATCH 1/2] services: configuration: Change formatting of generated Resent-From: Xinglu Chen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 09 Jun 2021 13:07:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 48934 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 48934@debbugs.gnu.org Received: via spool by 48934-submit@debbugs.gnu.org id=B48934.16232439968400 (code B ref 48934); Wed, 09 Jun 2021 13:07:02 +0000 Received: (at 48934) by debbugs.gnu.org; 9 Jun 2021 13:06:36 +0000 Received: from localhost ([127.0.0.1]:60762 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lqxum-0002BP-C3 for submit@debbugs.gnu.org; Wed, 09 Jun 2021 09:06:36 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:32938 helo=mail.yoctocell.xyz) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lqxui-0002Ay-M0 for 48934@debbugs.gnu.org; Wed, 09 Jun 2021 09:06:34 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1623243987; bh=YfxPEKFxM9q/JtnqgCSJxmOk2/nv/tOAx9c4HbOVT1s=; h=From:To:Subject:In-Reply-To:References:Date; b=e0zsV8/YWtRxPATytRkQA8pEVVN2HkcZ4EN6vngMmDXebVl7UVoeo1RXatWDFhs9R 6A/uTBhR9kxbdG3f7tG3YIbpet43JsKRPvPUTcNE1c7X26Sw3hTgOMKCwq4/la+qFq BKGM9vDuENeNMh6Y30sRMakYvNAf7Tk12O3rID2g= In-Reply-To: References: Message-Id: <07aed2e6ffe6c6fdab4a38207cafb7d3169c6e11.1623243063.git.public@yoctocell.xyz> Date: Wed, 09 Jun 2021 15:06:26 +0200 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" X-getmail-retrieved-from-mailbox: Patches * gnu/services/configuration (generate-documentation): Make the formatting of the generated docs more consistent with the rest of the docs in the “Services” section of the manual. --- gnu/services/configuration.scm | 54 ++++++++++++++++++---------------- 1 file changed, 28 insertions(+), 26 deletions(-) diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm index f23840ee6d..abcbc70520 100644 --- a/gnu/services/configuration.scm +++ b/gnu/services/configuration.scm @@ -239,32 +239,34 @@ does not have a default value" field kind))) (define (generate configuration-name) (match (assq-ref documentation configuration-name) ((fields . sub-documentation) - `((para "Available " (code ,(str configuration-name)) " fields are:") - ,@(map - (lambda (f) - (let ((field-name (configuration-field-name f)) - (field-type (configuration-field-type f)) - (field-docs (cdr (texi-fragment->stexi - (configuration-field-documentation f)))) - (default (catch #t - (configuration-field-default-value-thunk f) - (lambda _ '%invalid)))) - (define (show-default? val) - (or (string? val) (number? val) (boolean? val) - (and (symbol? val) (not (eq? val '%invalid))) - (and (list? val) (and-map show-default? val)))) - `(deftypevr (% (category - (code ,(str configuration-name)) " parameter") - (data-type ,(str field-type)) - (name ,(str field-name))) - ,@field-docs - ,@(if (show-default? default) - `((para "Defaults to " (samp ,(str default)) ".")) - '()) - ,@(append-map - generate - (or (assq-ref sub-documentation field-name) '()))))) - fields))))) + `((deftp (% (category "Data Type") (name ,(str configuration-name))) + (para "Available " (code ,(str configuration-name)) " fields are:") + (table (% (formatter (asis))) + ,@(map + (lambda (f) + (let ((field-name (configuration-field-name f)) + (field-type (configuration-field-type f)) + (field-docs (cdr (texi-fragment->stexi + (configuration-field-documentation f)))) + (default (catch #t + (configuration-field-default-value-thunk f) + (lambda _ '%invalid)))) + (define (show-default? val) + (or (string? val) (number? val) (boolean? val) + (and (symbol? val) (not (eq? val '%invalid))) + (and (list? val) (and-map show-default? val)))) + `(entry (% (heading (code ,(str field-name)) + ,@(if (show-default? default) + `(" (default: " (code ,(str default)) ")") + '()) + " (type: " + ,(str field-type) + ")")) + (para ,@field-docs) + ,@(append-map + generate + (or (assq-ref sub-documentation field-name) '()))))) + fields))))))) (stexi->texi `(*fragment* . ,(generate documentation-name)))) (define (configuration->documentation configuration-symbol) From patchwork Wed Jun 9 13:06:27 2021 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-Patchwork-Submitter: Xinglu Chen X-Patchwork-Id: 30078 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 B39BE27BC78; Wed, 9 Jun 2021 14:07:11 +0100 (BST) X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on mira.cbaines.net X-Spam-Level: X-Spam-Status: No, score=-2.8 required=5.0 tests=BAYES_00,DKIM_SIGNED, MAILING_LIST_MULTI,RCVD_IN_MSPIKE_H4,RCVD_IN_MSPIKE_WL,SPF_HELO_PASS, T_DKIM_INVALID,URIBL_BLOCKED autolearn=unavailable autolearn_force=no version=3.4.2 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) by mira.cbaines.net (Postfix) with ESMTPS id 43AF227BC81 for ; Wed, 9 Jun 2021 14:07:11 +0100 (BST) Received: from localhost ([::1]:36838 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lqxvK-0000ra-Bh for patchwork@mira.cbaines.net; Wed, 09 Jun 2021 09:07:10 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52608) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqxvD-0000r8-0W for guix-patches@gnu.org; Wed, 09 Jun 2021 09:07:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:49219) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lqxvC-0007VN-Q4 for guix-patches@gnu.org; Wed, 09 Jun 2021 09:07:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lqxvC-0002CX-Mi for guix-patches@gnu.org; Wed, 09 Jun 2021 09:07:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#48934] [PATCH 2/2] services: configuration: Show default value when it is a Resent-From: Xinglu Chen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 09 Jun 2021 13:07:02 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: followup 48934 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 48934@debbugs.gnu.org Received: via spool by 48934-submit@debbugs.gnu.org id=B48934.16232439978408 (code B ref 48934); Wed, 09 Jun 2021 13:07:02 +0000 Received: (at 48934) by debbugs.gnu.org; 9 Jun 2021 13:06:37 +0000 Received: from localhost ([127.0.0.1]:60764 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lqxum-0002BR-LH for submit@debbugs.gnu.org; Wed, 09 Jun 2021 09:06:36 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:32944 helo=mail.yoctocell.xyz) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lqxuj-0002B1-Mc for 48934@debbugs.gnu.org; Wed, 09 Jun 2021 09:06:34 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1623243988; bh=kKET/OblmL+GlyxnFyNM/fc7x5/iatuyLGKm/wvouB0=; h=From:To:Subject:In-Reply-To:References:Date; b=giHjy4RVTYC9EFBI7bajmKHp1kxJLNxHurPnxv7OIK0Ie+m3HTTY0gOcgWQluDyia FQj1H8T40SXlrWzg8siP73LGr8f65sLEAu0fmV+PoyiioLdvoylivMTZlD9F1a/VOZ CYShK/4MRV+WJUojHNP3ZwULi0y4j84MUsUXWerk= In-Reply-To: References: Message-Id: <9de0174c0818edd7c3f1f58a264a6ea3c5c3be50.1623243063.git.public@yoctocell.xyz> Date: Wed, 09 Jun 2021 15:06:27 +0200 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" X-getmail-retrieved-from-mailbox: Patches * gnu/services/configuration.scm (generate-documentation): If the default value of a field is a package, show the value of the ‘name’ field of the package. This might not be the correct name in some cases though. --- gnu/services/configuration.scm | 12 ++++++++++-- 1 file changed, 10 insertions(+), 2 deletions(-) diff --git a/gnu/services/configuration.scm b/gnu/services/configuration.scm index abcbc70520..99687d065a 100644 --- a/gnu/services/configuration.scm +++ b/gnu/services/configuration.scm @@ -252,12 +252,20 @@ does not have a default value" field kind))) (configuration-field-default-value-thunk f) (lambda _ '%invalid)))) (define (show-default? val) - (or (string? val) (number? val) (boolean? val) + (or (string? val) (number? val) (boolean? val) (package? val) (and (symbol? val) (not (eq? val '%invalid))) (and (list? val) (and-map show-default? val)))) + + (define (show-default val) + (cond + ((package? val) + ;; Maybe not always correct. + (package-name val)) + (else (str val)))) + `(entry (% (heading (code ,(str field-name)) ,@(if (show-default? default) - `(" (default: " (code ,(str default)) ")") + `(" (default: " (code ,(show-default default)) ")") '()) " (type: " ,(str field-type)