From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp0 ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms0.migadu.com with LMTPS id kBYhFYu8wGAoQAAAgWs5BA (envelope-from ) for ; Wed, 09 Jun 2021 15:05:15 +0200 Received: from aspmx1.migadu.com ([2001:41d0:8:6d80::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp0 with LMTPS id cIexEIu8wGBtJQAA1q6Kng (envelope-from ) for ; Wed, 09 Jun 2021 13:05:15 +0000 Received: from lists.gnu.org (lists.gnu.org [209.51.188.17]) (using TLSv1.2 with cipher ECDHE-RSA-AES256-GCM-SHA384 (256/256 bits)) (No client certificate requested) by aspmx1.migadu.com (Postfix) with ESMTPS id 64BBE2C7B3 for ; Wed, 9 Jun 2021 15:05:14 +0200 (CEST) Received: from localhost ([::1]:36614 helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1lqxtQ-0000ZT-Hw for larch@yhetil.org; Wed, 09 Jun 2021 09:05:12 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:52084) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqxtH-0000Z6-FA for guix-patches@gnu.org; Wed, 09 Jun 2021 09:05:03 -0400 Received: from debbugs.gnu.org ([209.51.188.43]:49210) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1lqxtG-00067P-93 for guix-patches@gnu.org; Wed, 09 Jun 2021 09:05:02 -0400 Received: from Debian-debbugs by debbugs.gnu.org with local (Exim 4.84_2) (envelope-from ) id 1lqxtG-00027o-3O for guix-patches@gnu.org; Wed, 09 Jun 2021 09:05:02 -0400 X-Loop: help-debbugs@gnu.org Subject: [bug#48934] [PATCH 0/2] Some improvements to (gnu services configuration) Resent-From: Xinglu Chen Original-Sender: "Debbugs-submit" Resent-CC: guix-patches@gnu.org Resent-Date: Wed, 09 Jun 2021 13:05:01 +0000 Resent-Message-ID: Resent-Sender: help-debbugs@gnu.org X-GNU-PR-Message: report 48934 X-GNU-PR-Package: guix-patches X-GNU-PR-Keywords: patch To: 48934@debbugs.gnu.org Cc: Maxim Cournoyer X-Debbugs-Original-To: guix-patches@gnu.org Received: via spool by submit@debbugs.gnu.org id=B.16232438838115 (code B ref -1); Wed, 09 Jun 2021 13:05:01 +0000 Received: (at submit) by debbugs.gnu.org; 9 Jun 2021 13:04:43 +0000 Received: from localhost ([127.0.0.1]:60748 helo=debbugs.gnu.org) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lqxsx-00026o-BV for submit@debbugs.gnu.org; Wed, 09 Jun 2021 09:04:43 -0400 Received: from lists.gnu.org ([209.51.188.17]:52342) by debbugs.gnu.org with esmtp (Exim 4.84_2) (envelope-from ) id 1lqxst-00026d-Eh for submit@debbugs.gnu.org; Wed, 09 Jun 2021 09:04:41 -0400 Received: from eggs.gnu.org ([2001:470:142:3::10]:51952) by lists.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqxst-0000YO-82 for guix-patches@gnu.org; Wed, 09 Jun 2021 09:04:39 -0400 Received: from h87-96-130-155.cust.a3fiber.se ([87.96.130.155]:52852 helo=mail.yoctocell.xyz) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1lqxsr-0005pu-7I for guix-patches@gnu.org; Wed, 09 Jun 2021 09:04:38 -0400 From: Xinglu Chen DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple; d=yoctocell.xyz; s=mail; t=1623243872; bh=5bBQE6rjKvTSx1/b3G8AEr8RCXtymh5IyYWIVfpszpc=; h=From:To:Cc:Subject:Date; b=pnLkIzSETXg0nSCgxedHt/9MKgVAPPk7DmsMe/xJtch+iWADLCbRp8UVn1ZP0rv0e 0Qn2Ot2/HQbzLuWWuqlXkfXtnL+ipEsb4L/kmQSUncHJqv6lVQl0df3ZJHNVsdwwAf BraShKg1SDUZQYwvE3Kvti5x/0fx1QEquYV7aayA= Message-Id: Date: Wed, 09 Jun 2021 15:04:31 +0200 MIME-Version: 1.0 Content-Type: multipart/signed; boundary="=-=-="; micalg=pgp-sha256; protocol="application/pgp-signature" Received-SPF: pass client-ip=87.96.130.155; envelope-from=public@yoctocell.xyz; helo=mail.yoctocell.xyz X-Spam_score_int: 30 X-Spam_score: 3.0 X-Spam_bar: +++ X-Spam_report: (3.0 / 5.0 requ) BAYES_00=-1.9, DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, DKIM_VALID_EF=-0.1, FROM_SUSPICIOUS_NTLD=0.498, FROM_SUSPICIOUS_NTLD_FP=1.597, PDS_OTHER_BAD_TLD=1.997, RDNS_DYNAMIC=0.982, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=no autolearn_force=no X-Spam_action: no action 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+larch=yhetil.org@gnu.org Sender: "Guix-patches" X-Migadu-Flow: FLOW_IN ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1623243915; h=from:from:sender:sender:reply-to:subject:subject:date:date: message-id:message-id:to:to:cc:cc:mime-version:mime-version: content-type:content-type:resent-cc:resent-from:resent-sender: resent-message-id:list-id:list-help:list-unsubscribe:list-subscribe: list-post:dkim-signature; bh=oABkzdxxMgQ8LjIYSQzs+brFDgdjLipx8T6ce20ySc4=; b=gJgzWshwXs30v72YXhp7T/EeMXgAbbVD346gsMEXv1/cCayhw1sy8vYoqNZY9bp4EVW4rP U3+L+8AKYN6S1RCelqR7P1+7Uj9T658zaKjpK6aY2ogrSVI165cND5cKfQahALnMnCeFBu w0qqjCkj5lbG/0RxZ+KsV/XTDKPUn0lYeQ6D1du2sZ3n0WWTj+BnhiJ8IKBIfW6Ct6450b 6HYBRYrB6NsVyVO0dwydkdCbhM5i7DcKJM5pQk3phtlVjeZs3QlL2TwibpOQmv8FaynA5t +7J3T97JDaqG2dy3V3+uQBbuWXc+OU4bY1tfOfPF806CO0QkvcycB6CNhwqa4A== ARC-Seal: i=1; s=key1; d=yhetil.org; t=1623243915; a=rsa-sha256; cv=none; b=gJAQ6isA8pY90NZKwxQH5MjpmSqhg2/eon1AAsWFdf6sUH5nvNI3Nz4pHQ5oESxgF5iIXq 9ie22Q9LzvDSUkf6yXl4s7aBAqm1sXBq0m7Sq3VOQ90ty5tFW4ks5+agv/gxf2vRPhONxr 4YUM93fftfCcyIyyqVfjKc0qLYXS/9X9cBEVEr+6pMjq6IH/g77q2FaZ/X/6u9dCAjRyY5 hnCrO2pn5WNLOk72olBPlefpJEIsS0Ggu6n7UT3n72SQjoaS7FpE4XyyHw3xBsn7jnUF9C 9DtVAabrS6vjFgSJ4AXFJ6s4z24frRi8xgL71CDEN/TtsIHu4vGWuPVk6ixrLg== ARC-Authentication-Results: i=1; aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=pnLkIzSE; spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Spam-Score: -2.43 Authentication-Results: aspmx1.migadu.com; dkim=fail ("headers rsa verify failed") header.d=yoctocell.xyz header.s=mail header.b=pnLkIzSE; dmarc=fail reason="SPF not aligned (relaxed)" header.from=yoctocell.xyz (policy=none); spf=pass (aspmx1.migadu.com: domain of guix-patches-bounces@gnu.org designates 209.51.188.17 as permitted sender) smtp.mailfrom=guix-patches-bounces@gnu.org X-Migadu-Queue-Id: 64BBE2C7B3 X-Spam-Score: -2.43 X-Migadu-Scanner: scn0.migadu.com X-TUID: yewVSSjUQpwx --=-=-= Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: quoted-printable This series contains some improvements to the (gnu services configuration) module. The first patch changes the formatting of the generated documentation for configuration records. Previously, the generated documentation looked a bit different from the ones that were to generated, compare the docs for =E2=80=98getmail-configuration=E2=80=99 (generated) and =E2=80=98o= penssh-configuration=E2=80=99 (not generated). =2D-8<---------------cut here---------------start------------->8--- Available =E2=80=98getmail-configuration=E2=80=99 fields are: -- =E2=80=98getmail-configuration=E2=80=99 parameter: symbol name A symbol to identify the getmail service. Defaults to =E2=80=98"unset"=E2=80=99. -- =E2=80=98getmail-configuration=E2=80=99 parameter: package package The getmail package to use. =2D-8<---------------cut here---------------end--------------->8--- =2D-8<---------------cut here---------------start------------->8--- -- Data Type: openssh-configuration This is the configuration record for OpenSSH=E2=80=99s =E2=80=98sshd= =E2=80=99. =E2=80=98openssh=E2=80=99 (default OPENSSH) The Openssh package to use. =E2=80=98pid-file=E2=80=99 (default: =E2=80=98"/var/run/sshd.pid"=E2= =80=99) Name of the file where =E2=80=98sshd=E2=80=99 writes its PID. =E2=80=98port-number=E2=80=99 (default: =E2=80=9822=E2=80=99) TCP port on which =E2=80=98sshd=E2=80=99 listens for incoming con= nections. =2D-8<---------------cut here---------------end--------------->8--- The first patch will make the generated documentation look at lot more similiar to the hand-written ones. =2D-8<---------------cut here---------------start------------->8--- -- Data Type: getmail-configuration Available =E2=80=98getmail-configuration=E2=80=99 fields are: =E2=80=98name=E2=80=99 (default: =E2=80=98"unset"=E2=80=99) (type: sym= bol) A symbol to identify the getmail service. =E2=80=98package=E2=80=99 (default: =E2=80=98getmail=E2=80=99) (type: = package) The getmail package to use. =2D-8<---------------cut here---------------end--------------->8--- If you paid close attention you will also notice that the old generated docs didn=E2=80=99t specify the default value of the =E2=80=98package=E2=80= =99 field, whereas the new docs do. This brings us to the second patch, it looks the package and shows the value of the =E2=80=98name=E2=80=99 field of the pack= age. This will only show the correct package name if the =E2=80=98name=E2=80=99 field= and the Scheme variable corresponding to the package are the same, in most cases it is, so I don=E2=80=99t think it would be a huge deal. Xinglu Chen (2): services: configuration: Change formatting of generated documentation. services: configuration: Show default value when it is a package. gnu/services/configuration.scm | 62 ++++++++++++++++++++-------------- 1 file changed, 36 insertions(+), 26 deletions(-) base-commit: 86bb77608d375043f837583332a7c852ea2080ec =2D-=20 2.32.0 --=-=-= Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iQJJBAEBCAAzFiEEAVhh4yyK5+SEykIzrPUJmaL7XHkFAmDAvF8VHHB1YmxpY0B5 b2N0b2NlbGwueHl6AAoJEKz1CZmi+1x579cP/jGOaroYfsMlBf+SY0/QSHBFBzh8 +3DGfyA5/ltMzBLHAe7aFSWUItHJqrUfGxkix2preh8iVHCq9KoGMxMr0BdEP80L t7nj+ciTE8ua10NcIW7RJTvaAeHkpb6pcEXh2mynS5sw2/z9GlcG9rX2TuyFE9mA Ov7rEp64Czg+yfJEmRy+D9G6JUzhJzPVzk6Uu5j9lL/7oNUB/pdEOteY/kQo+LOD aP0dM5UZeSzVxT0RtZcSR5pwZEtUiNht/5VesPJKtXk5lK2bgHYKfDaQjYt3kTcF vdNbZvrQYsJGSW5VORP2kKFpE9+iNebi5rP40dPnpT45H9NqgI98WM5USIauTyLU 9cxG13R+BV6F50eHSX+hF4/nOh5PmUtR2gmdv9sFLUzsq682GzAU1WYDkwxgg8qZ ciTYb0C0PiTdLmxKF6Tw3VibBcZWpE6SdugxqDfvaBzphzpkZ91oFPbExnQJQoy2 rIigctfHHegnIqdbkanuZkkgCQYL63W+qf7UtXf5Pw6NNG6M+Uh9BU3sQoMjGRLS CJvdq8/WbLs8/wh9YV2QG8HaMlCOV2YiAQ6UJj6WZz12DNZ0G+5KRsAzwIdNPZ6X 6u0AzLH5Wk6aYxBQ3iQgLmQKRGk4SVFhNukjL5Bgj0fFC7ITTpWQZlEpw9LvouEk n2YqoFUdNT22EWOI =cAuz -----END PGP SIGNATURE----- --=-=-=--