From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from mp2.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by ms1.migadu.com with LMTPS id aP20Aw1BGmY5hgAAe85BDQ:P1 (envelope-from ) for ; Sat, 13 Apr 2024 10:23:41 +0200 Received: from aspmx1.migadu.com ([2001:41d0:303:e16b::]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits)) by mp2.migadu.com with LMTPS id aP20Aw1BGmY5hgAAe85BDQ (envelope-from ) for ; Sat, 13 Apr 2024 10:23:41 +0200 X-Envelope-To: larch@yhetil.org Authentication-Results: aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=EnM6qHj1; 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"); dmarc=none ARC-Message-Signature: i=2; a=rsa-sha256; c=relaxed/relaxed; d=yhetil.org; s=key1; t=1712996620; 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=eVXWesVcssVokjtxt7j9iebFU3qRrp5ydO1FleQFacE=; b=NXLMCq94g6ULylH2GnnN0mOBH0sDAIzRXLGao7EjxrRfN3JkO/NXrfre/bAN67HzOcMESC ZW4iYKuwgGFPJ7rTb3wNjxnrjcZRAHvLzDbSdGzxFb/cWY9GSiTXjttiuAffPuKjT6giRk x2xR2GxBneEvtlMSJL7loDCJMHPf/bYZrc+8PLi77aIgpDHFz1pWa71sqHV0r7Vso3dpT1 h+oDy2paX/FGwa3m/IVaJCtLN8BL0e8aaVPsz9lBTsFcsFfngLF/+2BQ5YqB6wl7ZV7hId eAMGya2CcwPw6npuGhuCxX1J+UaIoVJ2vrbXXLZbikMvBMGvwVb6wNFeWUCsNg== ARC-Seal: i=2; s=key1; d=yhetil.org; t=1712996620; a=rsa-sha256; cv=pass; b=oOTDvXrx8A3czDqq6eMaVLgC1SecBNQPOk/y4mmRd+lYS+8fAD/m5z44NiWEM6Pl1jJAFy Na3VOA2EVGtz38aYDxzv0Wq7MmIRodPpXj8+qS0fABUrpPes4pzc/ryBp9Y1N+2RFgPl7u vIgc/+XV2RexHkMJJjZPvk+oOX1QSqlDGoAJ9YqADKiVKa3inUFe0ePfnUE4JleANNL/DK LVpSZJMYMBZSgNCsdHewaj+rXZ5vxB6l0oUB/RMh7VLedr0jg/jv7bi8A0WhHIBRYAEgzR JtxGiBaK1XVJwYgoH88hrOcBc9ApGGr/9E8Qn5CJ7mOEbgLsnH9bZvUiiB/gPA== ARC-Authentication-Results: i=2; aspmx1.migadu.com; dkim=pass header.d=excalamus.com header.s=zmail header.b=EnM6qHj1; 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"); dmarc=none 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 BECB93D235 for ; Sat, 13 Apr 2024 10:23:40 +0200 (CEST) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1rvYfD-0000gu-2H; Sat, 13 Apr 2024 04:23:07 -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 1rvYfB-0000gg-9P for guix-devel@gnu.org; Sat, 13 Apr 2024 04:23:05 -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 1rvYf9-0002hI-Kc; Sat, 13 Apr 2024 04:23:05 -0400 ARC-Seal: i=1; a=rsa-sha256; t=1712996578; cv=none; d=zohomail.com; s=zohoarc; b=ANx2Ub26GiQnlAgtT+hjosczCsCeHBL6LL9Ld9Zm5idgdXUiNRfEu/xCmoF4IuEua5xLez8M9GQjPxUlYDd0Zhdi/uBQN6AsRDH2dX4juU6FeUYbo5yknHcKqNVNhdLqn+MOGKapFtvqD08pBgNOszCK2mXnUWNpo5BbqhAGKt0= ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=zohomail.com; s=zohoarc; t=1712996578; 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=eVXWesVcssVokjtxt7j9iebFU3qRrp5ydO1FleQFacE=; b=LWlDLyxUOLrgYYkXm9tTviCI74Qpf6E2ifTQK85XzGHuUCsgQmzS+aapp1a9LnklKhasLsBKksxQOO+r33diYWoLai3AY4Ew5deq8W+CBEA9ZIxJ6+y4F81o9JlE0WV0xV2VkA2wN0qUrbD7d5P5jhaF1ACSN27b49NIXWvSMww= 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=1712996578; 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=eVXWesVcssVokjtxt7j9iebFU3qRrp5ydO1FleQFacE=; b=EnM6qHj1HTV/TI5EKdxqZ/utCiGfOBJ85JATqbp1NozCEa2HtUBlLdc4Tt7xk6JF U4yP5Ji7y41VamBwibT7CmJC3na1zjFs/JJK6Zs0dmO9fesvqEBvV71mhzHDnNqXq0L iPWFMtSJoh05/CQ1B4a/oPvUo1QUkNEUpYJjmqjY= Received: from mail.zoho.com by mx.zohomail.com with SMTP id 1712996576175421.1849335273623; Sat, 13 Apr 2024 01:22:56 -0700 (PDT) Date: Sat, 13 Apr 2024 10:22:56 +0200 From: Matt To: =?UTF-8?Q?=22Ludovic_Court=C3=A8s=22?= Cc: "guix-devel" , "pelzflorian" , "maximcournoyer" , "dev" Message-Id: <18ed68d6b94.f9d1ef36556415.1918708820162605634@excalamus.com> In-Reply-To: <87il0m49qw.fsf@gnu.org> References: <87a5p8yn4p.fsf@dadoes.de> <18ec853a933.df0e6c395339428.1434045801453734872@excalamus.com> <87il0m49qw.fsf@gnu.org> Subject: Re: Fix grammar and markup (was Re: Feedback of the GNU Guix manual) MIME-Version: 1.0 Content-Type: multipart/mixed; boundary="----=_Part_1819695_1434590480.1712996576148" 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.927.13 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-Country: US X-Migadu-Flow: FLOW_IN X-Migadu-Spam-Score: -6.52 X-Spam-Score: -6.52 X-Migadu-Queue-Id: BECB93D235 X-Migadu-Scanner: mx13.migadu.com X-TUID: 1xYryuL7xOpq ------=_Part_1819695_1434590480.1712996576148 Content-Type: text/plain; charset="UTF-8" Content-Transfer-Encoding: quoted-printable ---- On Fri, 12 Apr 2024 22:16:39 +0200 Ludovic Court=C3=A8s wrote ---= =20 > > See @ref{Substitutes} for how to allow the daemon to download pre-buil= t binaries. >=20 > Nitpick: this works but I believe the recommended approach is > =E2=80=9C@xref{Substitutes} for how=E2=80=A6=E2=80=9D. >=20 > https://www.gnu.org/software/texinfo/manual/texinfo/html_node/Cross-Re= ference-Commands.html =20 Good catch! I took the opportunity and found several similar issues elsewh= ere. The attached patch tries to correct them. > Thanks for reporting these issues! I appreciate your assistance with these details :) ------=_Part_1819695_1434590480.1712996576148 Content-Type: application/octet-stream; name=0001-doc-Fix-cross-references.patch Content-Transfer-Encoding: 7bit X-ZM_AttachId: 139322893761480260 Content-Disposition: attachment; filename=0001-doc-Fix-cross-references.patch >From bc8d3654f8c1d3271596d0eafb48b02421236e1c Mon Sep 17 00:00:00 2001 From: Matthew Trzcinski Date: Sat, 13 Apr 2024 10:12:05 +0200 Subject: [PATCH] doc: Fix cross-references * doc/guix.texi (Setting Up the Daemon): use @xref to start sentence. (Build Systems): capitalize "python" and start parenthesized reference with @pxref. (Linux Services): use @xref to start phrase. (Configuring the Shell): use @xref to start phrase. --- doc/guix.texi | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/doc/guix.texi b/doc/guix.texi index 5efbd00984..b117a2d03c 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 @ref{Substitutes} for how to allow the daemon to -download pre-built binaries. +environment. @xref{Substitutes} for how to allow the daemon to download +pre-built binaries. @menu * Build Environment Setup:: Preparing the isolated build environment. @@ -9086,7 +9086,7 @@ package name should be prefixed with the lisp implementation, such as @code{sbcl-} for @code{asdf-build-system/sbcl}. Additionally, the corresponding source package should be labeled using -the same convention as python packages (see @ref{Python Modules}), using +the same convention as Python packages (@pxref{Python Modules}), using the @code{cl-} prefix. In order to create executable programs and images, the build-side @@ -39603,9 +39603,9 @@ The package providing the @command{fstrim} command. @item @code{schedule} (default: @code{"0 0 * * 0"}) (type: mcron-time) Schedule for launching @command{fstrim}. This can be a procedure, a -list or a string. For additional information, see @ref{Guile -Syntax,,Job specification,mcron,the mcron manual}. By default this is -set to run weekly on Sunday at 00:00. +list or a string. For additional information, @xref{Guile Syntax,,Job +specification,mcron,the mcron manual}. By default this is set to run +weekly on Sunday at 00:00. @item @code{listed-in} (default: @code{'("/etc/fstab" "/proc/self/mountinfo")}) (type: maybe-list-of-strings) List of files in fstab or kernel mountinfo format. All missing or empty @@ -44229,9 +44229,9 @@ Guix Home. Otherwise, read it carefully. There are a few scripts that must be evaluated by a login shell to activate the home environment. The shell startup files only read by login shells often have @code{profile} suffix. For more information -about login shells see @ref{Invoking Bash,,, bash, The GNU Bash -Reference Manual} and see @ref{Bash Startup Files,,, bash, The GNU Bash -Reference Manual}. +about login shells, @xref{Invoking Bash,,, bash, The GNU Bash Reference +Manual} and @xref{Bash Startup Files,,, bash, The GNU Bash Reference +Manual}. The first script that needs to be sourced is @file{setup-environment}, which sets all the necessary environment variables (including variables -- 2.41.0 ------=_Part_1819695_1434590480.1712996576148--