Fixing Zabbix db-secret-file documentation.

[Tobias Geerinckx-Rice]

Guix,




To me that can only mean:

 $ cat db-secret-file
 $DB['PASSWORD'] = 'supersecure'
 $DB['maybe'] = 'some more sekrit stuff too'

but it's really just:

 "$DB['PASSWORD'] = '" (with-input-from-file db-secret-file
                                            read-string) "';"



Kind regards,

T G-R


From c6746726e4db7f674297de79ae599ca9686658a1 Mon Sep 17 00:00:00 2001
From: Tobias Geerinckx-Rice <m...@tobias.gr>
Date: Fri, 6 Nov 2020 13:17:00 +0100
Subject: [PATCH 1/2] =?UTF-8?q?doc:=20Fix=20Zabbix=20?=
 =?UTF-8?q?=E2=80=98db-secret-file=E2=80=99=20documentation.?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

* doc/guix.texi (Monitoring Services): Document ‘db-secret-file’'s (lack
of) structure and gexp support.
---
 doc/guix.texi | 7 ++++---
 1 file changed, 4 insertions(+), 3 deletions(-)

diff --git a/doc/guix.texi b/doc/guix.texi
index 217ed7a8a8..1c29799d6c 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -22168,9 +22168,10 @@ Defaults to @samp{""}.
 @end deftypevr
 
 @deftypevr {@code{zabbix-front-end-configuration} parameter} string db-secret-file
-Secret file which will be appended to @file{zabbix.conf.php} file.  This
-file contains credentials for use by Zabbix front-end.  You are expected
-to create it manually.
+Secret file containing the credentials for the Zabbix front end.  The value
+must be a local file name, not a G-expression.  You are expected to create
+this file manually.  Its contents will be copied into @file{zabbix.conf.php}
+as the value of @code{$DB['PASSWORD']}.
 
 Defaults to @samp{""}.
 
-- 
2.29.2

We currently claim that db-secret-file is appended to zabbix.conf.php. It's late into 1.2 to invalidate manual translations. However, I'm sceptical of shipping a translated-but-IMO-incorrect snippet over a better English one just to boost coverage stats, and would like to push it anyway. Thoughts?

signature.asc
Description: PGP signature