From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms1.migadu.com with LMTPS id KNURFLmcFmaRBwAAe85BDQ:P1 (envelope-from ) for ; Wed, 10 Apr 2024 16:05:45 +0200 Received: from aspmx1.migadu.com ([2001:41d0:403:58f0::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id KNURFLmcFmaRBwAAe85BDQ (envelope-from ) for ; Wed, 10 Apr 2024 16:05:45 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=E21+s0Os; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org"; arc=pass ("zohomail.com:s=zohoarc:i=1") ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1712757945; 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:in-reply-to:in-reply-to: references:references:list-id:list-help:list-unsubscribe: list-subscribe:list-post:dkim-signature; bh=NNU2gTLsvnUA0lXxh9YVmImWWKifHRCJgG8r9S0N/aA=; b=sqHowSDWwPuxX09/rW1FqBIac0zKu4nHO95jWr/Lh06VBi8j7BPQSd4iKPrWHuQihboBfB QXGUISZ1SKsTMG4VxkvwZ9Ia0/kAw4ZHA7n1Q9yAU01EhOAizBuqCfLg1BSqIfVdTkCvZp OdM58j2RHltaWid1POF50RbT6JR225K2yDSK70xk2S2WVt9K+h3ATHOWFYO3PQPkzJOfQl Sk5jfpnaOsziz0cX804UniaUdKuDLG7soTQHW3WiHSCxzHtnwvhqMKG4Lm81hXisIjBpiX qEptrNzoN5m2JDJJ6Eugs7v4uqhJP1ks1P7lMIhwdf+Pot2dmqaXl+oRLdhQ8g== ARC-Authentication-Results: i=2; aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=E21+s0Os; dmarc=none; spf=pass (aspmx1.migadu.com: domain of "guix-devel-bounces+larch=yhetil.org@gnu.org" designates 209.51.188.17 as permitted sender) smtp.mailfrom="guix-devel-bounces+larch=yhetil.org@gnu.org"; arc=pass ("zohomail.com:s=zohoarc:i=1") ARC-Seal: i=2; s=key1; d=yhetil.org; t=1712757945; a=rsa-sha256; cv=pass; b=OYhcE9Ihj1jBISdqbdAK0S2NA6pOEXynwHfVPWdW+JfsCFqJw1hWLAIhcrsAjaIzsXiN/5 cNRus0I+22rbc8UsBURsK+IcINlpQv12neehRXaNirTbq0E88RVir1dIKB9WqGO8uXM9Wl 9AJYKQbAUbxDcQXjpvmWpaDDz5BeEKloPZOO/wrUn2vg4Q7IbW3MyV11rbaz7yM/FhmiEz ud1vtMiKfXq9Rbc/v5EdN0VxLSAGv98aVBjExuIYhwB+tjbfIciJjWF6uN7FygrLWgFRGO BPPJi1RRuIDtw2b71mY6O7nlC35WVZM+jEI4PEhmBn+OOp5yOSSvSSaYacpkgg== 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 1974D6433C for ; Wed, 10 Apr 2024 16:05:45 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1ruYZs-0000jc-AV; Wed, 10 Apr 2024 10:05:28 -0400 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 1ruYZq-0000jM-Ni for guix-devel@gnu.org; Wed, 10 Apr 2024 10:05:26 -0400 Received: from sender4-pp-f112.zoho.com ([136.143.188.112]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_256_GCM_SHA384:256) (Exim 4.90_1) (envelope-from ) id 1ruYZo-0006ug-Qe for guix-devel@gnu.org; Wed, 10 Apr 2024 10:05:26 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1712757914; cv=none; d=zohomail.com; s=zohoarc; b=DNFt8fEBXfVPfmZ6UHSVlPkn0DgufeLxWXRZdS4qwqSlHxbVcKrjrXnwn4xQWTj5jt9eDyiQzZ9HU250dJTsT7LatVoszKO3MjIWNMyc/pRgN/lLS6HkdroVF3CZnCGKuG6LyLYNJFiSdwrNYP0v27dbgrCF//qnsYggoJfpQHY= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1712757914; h=Content-Type:Cc:Cc:Date:Date:From:From:In-Reply-To:MIME-Version:Message-ID:References:Subject:Subject:To:To:Message-Id:Reply-To; bh=NNU2gTLsvnUA0lXxh9YVmImWWKifHRCJgG8r9S0N/aA=; b=IxZwTvUDcYIsQMB0bu5dNIXSyV/aBQ9mukb8ccNmZNZa9NR0meXgV+PcYJ1UUkaUaLn9FCcM4y9wA9b7vLqhKoqWG1NTa/h+/a+Fq+VJwbj7/fFCo0vrhPhagV/8EwD/wma6VMqcpU2MeTKko5TCt5s5XAeKwtIt53tFCBp3N+Q= ARC-Authentication-Results: i=1; mx.zohomail.com; dkim=pass header.i=excalamus.com; spf=pass smtp.mailfrom=matt@excalamus.com; dmarc=pass header.from= DKIM-Signature: v=1; a=rsa-sha256; q=dns/txt; c=relaxed/relaxed; t=1712757914; s=zmail; d=excalamus.com; i=matt@excalamus.com; h=Date:Date:From:From:To:To:Cc:Cc:Message-Id:Message-Id:In-Reply-To:References:Subject:Subject:MIME-Version:Content-Type:Reply-To; bh=NNU2gTLsvnUA0lXxh9YVmImWWKifHRCJgG8r9S0N/aA=; b=E21+s0OsQ6+SG+QztaSqm+HEBYvI6ztPVUTFDVB5g/fU51RWPtoS2lBfojd5sEUO 0sNpM269IXqM06FTPxEpAc/9Wb6g32jIR9VPJ5qWRtMnMhFAZGGGaPSbAPP4n92omRO FcDnTEk6EeDt0yxDo4+KnJ1waa9rWVGxw7v4sMgc= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1712757909844388.012205749773; Wed, 10 Apr 2024 07:05:09 -0700 (PDT) Date: Wed, 10 Apr 2024 16:05:09 +0200 From: Matt To: "guix-devel" Cc: "Christian Miller" , "pelzflorian" , "maximcournoyer" , "dev" Message-Id: <18ec853a933.df0e6c395339428.1434045801453734872@excalamus.com> In-Reply-To: <87a5p8yn4p.fsf@dadoes.de> References: <87a5p8yn4p.fsf@dadoes.de> Subject: Fix grammar and markup (was Re: Feedback of the GNU Guix manual) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="----=_Part_17202596_2040449575.1712757909812" Importance: Medium User-Agent: Zoho Mail X-Mailer: Zoho Mail X-Zoho-Virus-Status: 1 X-Zoho-AV-Stamp: zmail-av-1.1.0/212.666.40 Received-SPF: pass client-ip=136.143.188.112; envelope-from=matt@excalamus.com; helo=sender4-pp-f112.zoho.com X-Spam_score_int: -20 X-Spam_score: -2.1 X-Spam_bar: -- X-Spam_report: (-2.1 / 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, RCVD_IN_DNSWL_NONE=-0.0001, RCVD_IN_MSPIKE_H4=0.001, RCVD_IN_MSPIKE_WL=0.001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: guix-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: "Development of GNU Guix and the GNU System distribution." List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: guix-devel-bounces+larch=yhetil.org@gnu.org Sender: guix-devel-bounces+larch=yhetil.org@gnu.org X-Migadu-Flow: FLOW_IN X-Migadu-Country: US X-Migadu-Spam-Score: -6.56 X-Migadu-Scanner: mx11.migadu.com X-Spam-Score: -6.56 X-Migadu-Queue-Id: 1974D6433C X-TUID: vq/tWp1KqE5G ------=_Part_17202596_2040449575.1712757909812 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: 7bit We're working through a list of feedback one item at a time: https://lists.gnu.org/archive/html/guix-devel/2024-01/msg00117.html We have completed the first two items. The next item reported is: #+begin_quote 2.4 Setting up the deamon Seems like an issue with info. Have seen this in the Emacs manual as well. There is also sometimes see see (doc) L15 See also see Substitutes. #+end_quote This sounds like the use of an @xref instead of @ref. However, I can't find it in the current version (5a95cf76) of the documentation, nor the reported version (ee7c9d25). The last change to doc/guix.texi at that the reported time was in e5ed1712 (git log -n 1 ee7c9d25 -- doc/guix.texi). The full reported sentence currently reads, #+begin_quote See also @ref{Substitutes}, for information on how to allow the daemon to download pre-built binaries. #+end_quote The use of the comma after "Substitutes" is inappropriate, if I have the terminology correct, because "See also Substitutes" is not a participial phrase. "Also" and "information on" are also unnecessary. I suggest the following: #+begin_quote See @ref{Substitutes} for how to allow the daemon to download pre-built binaries. #+end_quote Searching for "see also" turns up the following in 'Mail Services': #+begin_quote See also ssl=required setting. #+end_quote This needs "the" before "ssl=required" as it refers to a specific setting. It should probably use the @option or @samp markup: #+begin_quote See also the @samp{ssl=required} setting. #+end_quote I have opted for @samp because it's used elsewhere for similar items. In the same section is: #+begin_quote NOTE: See also @samp{disable-plaintext-auth} setting. #+end_quote This too should have "the" before the setting. The "NOTE:" designation is also unnecessary. I suggest: #+begin_quote See also the @samp{disable-plaintext-auth} setting. #+end_quote Included is a patch which makes these suggested changes. It was advised to submit the previous patch to guix-patches. I opted to submit this next patch here to keep the thread connected since it's part of a larger discussion (I suppose). If we're agreed that guix-patches is more appropriate, I can submit the next item in a new thread there using the same message format I've been following. Thoughts? ------=_Part_17202596_2040449575.1712757909812 Content-Type: application/octet-stream; name=0001-doc-Fix-grammar-and-markup.patch Content-Transfer-Encoding: 7bit X-ZM_AttachId: 139320507098120660 Content-Disposition: attachment; filename=0001-doc-Fix-grammar-and-markup.patch >From 880264a6887621891a35e637788ddcd63c5bcb54 Mon Sep 17 00:00:00 2001 From: Matthew Trzcinski Date: Wed, 10 Apr 2024 15:44:36 +0200 Subject: [PATCH] doc: Fix grammar and markup doc/guix.texi (Setting Up the Daemon): Remove comma and extra words. doc/guix.texi (Mail Services): Add definite article to setting. Use @samp markup on setting. --- doc/guix.texi | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 5827e0de14..5efbd00984 100644 --- a/doc/guix.texi +++ b/doc/guix.texi @@ -848,8 +848,8 @@ goes through the daemon. For instance, command-line tools such as daemon (@i{via} remote procedure calls) to instruct it what to do. The following sections explain how to prepare the build daemon's -environment. See also @ref{Substitutes}, for information on how to allow -the daemon to download pre-built binaries. +environment. See @ref{Substitutes} for how to allow the daemon to +download pre-built binaries. @menu * Build Environment Setup:: Preparing the isolated build environment. @@ -26641,7 +26641,7 @@ Disable LOGIN command and all other plaintext authentications unless SSL/TLS is used (LOGINDISABLED capability). Note that if the remote IP matches the local IP (i.e.@: you're connecting from the same computer), the connection is considered secure and plaintext authentication is -allowed. See also ssl=required setting. +allowed. See also the @samp{ssl=required} setting. Defaults to @samp{#t}. @end deftypevr @@ -26781,7 +26781,7 @@ Defaults to @samp{#f}. List of wanted authentication mechanisms. Supported mechanisms are: @samp{plain}, @samp{login}, @samp{digest-md5}, @samp{cram-md5}, @samp{ntlm}, @samp{rpa}, @samp{apop}, @samp{anonymous}, @samp{gssapi}, -@samp{otp}, @samp{skey}, and @samp{gss-spnego}. NOTE: See also +@samp{otp}, @samp{skey}, and @samp{gss-spnego}. See also the @samp{disable-plaintext-auth} setting. @end deftypevr -- 2.41.0 ------=_Part_17202596_2040449575.1712757909812--