From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org 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 smtp.lore.kernel.org (Postfix) with ESMTPS id D28D6EE49A5 for ; Sun, 20 Aug 2023 01:58:31 +0000 (UTC) Received: from localhost ([::1] helo=lists1p.gnu.org) by lists.gnu.org with esmtp (Exim 4.90_1) (envelope-from ) id 1qXXhV-00050y-Fh; Sat, 19 Aug 2023 21:57:57 -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 1qXXhU-00050b-7n for grub-devel@gnu.org; Sat, 19 Aug 2023 21:57:56 -0400 Received: from mail-wm1-x333.google.com ([2a00:1450:4864:20::333]) by eggs.gnu.org with esmtps (TLS1.2:ECDHE_RSA_AES_128_GCM_SHA256:128) (Exim 4.90_1) (envelope-from ) id 1qXXhR-00006X-84 for grub-devel@gnu.org; Sat, 19 Aug 2023 21:57:55 -0400 Received: by mail-wm1-x333.google.com with SMTP id 5b1f17b1804b1-3fe2fb9b4d7so20361105e9.1 for ; Sat, 19 Aug 2023 18:57:52 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20221208; t=1692496671; x=1693101471; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date:from:to:cc :subject:date:message-id:reply-to; bh=PTMiHBB/dTSciEO1F6Ki92ph/cLvMo6jA1AlbRlkRRs=; b=XyeKHISCkd/Kgc/T/I4t11ub9Iv2c5LJ6NrkBjmrjLQ/O9E8MGRikhISrcP7vFAmws Fvfwoy3d/WiQ48hEcPUe20nSiC+sAqhsJjPcxFHdzJdy6yx8Lq8s/OB2v24dDAkG/5TD kUDT/MXEfajSqIgl1EPePrCeAmAlmlg7tbtxpvUry5VoATvgq/2pQxbkVcD53/jkzZ7Y STWXuaeYpMSHvUH8dr7Gv08RG0IPt6aLdaExlXsGcXnjebHyvot/x6SbA6WVe+EluE2D 0m8oHWTvHiSoRg8KF+4YWT0YpQ2DaISCJxK/o+uzYQ9BCqayx2pK6eeyQdr55bH+VevC uV9w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20221208; t=1692496671; x=1693101471; h=in-reply-to:content-disposition:mime-version:references :mail-followup-to:message-id:subject:cc:to:from:date :x-gm-message-state:from:to:cc:subject:date:message-id:reply-to; bh=PTMiHBB/dTSciEO1F6Ki92ph/cLvMo6jA1AlbRlkRRs=; b=YhsLSxw2BUonMNQQe5yiukzLrOAkU/ROyY71nyNDgDOuPtY74pzwTtBeyZkW/4xgHS D1AT0iDWRq2mMzM8fWlX0DjpjtDrpiH5VnWuDZiEDsBr718ip6bL8710qnKFWNRO8mkJ UURS2eahn02A65UW1g0QPOFPlw3/MFwMIkMZO+vQDHc3LLiXuXQZ/2OAUuYE7xjYrwPF uvJ/UHUqB7AV3b47a/1Lh7ZtcBLHdzIVgHAguh/il7ykpg3+Dnzayjp6i25yUOrYo2l5 x3y0jcgxcTTrOscFmcRpgCqWSDzBbxCsw3nwe9/bWYM6HxIzEpQd3t4PJ0OO08cre0xV NVWw== X-Gm-Message-State: AOJu0YyucYhusEwVnN+jY00Kfkk//4G99Tb5Z7RVHyuaQd9iwRcc8/Pt tsucEmNkIoBGgxy8hV+Mogc473e5g8c= X-Google-Smtp-Source: AGHT+IENllG94ZtZi5Kgj6F8B9CtrPihjk1f5YKY0fnj2WVddlnZjRppqQr4x8GQrvnKdK5yP0FVjA== X-Received: by 2002:a05:600c:2218:b0:3fe:ad3:b072 with SMTP id z24-20020a05600c221800b003fe0ad3b072mr2105717wml.17.1692496670877; Sat, 19 Aug 2023 18:57:50 -0700 (PDT) Received: from dj3ntoo (161.sub-97-139-114.myvzw.com. [97.139.114.161]) by smtp.gmail.com with ESMTPSA id y19-20020a1c4b13000000b003fbe4cecc3bsm11043862wma.16.2023.08.19.18.57.48 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Sat, 19 Aug 2023 18:57:50 -0700 (PDT) Date: Sat, 19 Aug 2023 20:57:45 -0500 From: Oskari Pirhonen To: Glenn Washburn Cc: grub-devel@gnu.org, Daniel Kiper , Olaf Hering Subject: Re: [PATCH 1/2] docs: Use @pxref instead of @xref inside parenthesis Message-ID: Mail-Followup-To: Glenn Washburn , grub-devel@gnu.org, Daniel Kiper , Olaf Hering References: MIME-Version: 1.0 In-Reply-To: Received-SPF: pass client-ip=2a00:1450:4864:20::333; envelope-from=xxc3ncoredxx@gmail.com; helo=mail-wm1-x333.google.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, FREEMAIL_FROM=0.001, RCVD_IN_DNSWL_NONE=-0.0001, SPF_HELO_NONE=0.001, SPF_PASS=-0.001 autolearn=ham autolearn_force=no X-Spam_action: no action X-BeenThere: grub-devel@gnu.org X-Mailman-Version: 2.1.29 Precedence: list List-Id: The development of GNU GRUB List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Reply-To: The development of GNU GRUB Content-Type: multipart/mixed; boundary="===============2926893704785003190==" Errors-To: grub-devel-bounces+grub-devel=archiver.kernel.org@gnu.org Sender: grub-devel-bounces+grub-devel=archiver.kernel.org@gnu.org --===============2926893704785003190== Content-Type: multipart/signed; micalg=pgp-sha256; protocol="application/pgp-signature"; boundary="Njdg9bRx3OVlFZ7+" Content-Disposition: inline --Njdg9bRx3OVlFZ7+ Content-Type: text/plain; charset=us-ascii Content-Disposition: inline Content-Transfer-Encoding: quoted-printable On Sat, Aug 19, 2023 at 01:25:16 -0500, Glenn Washburn wrote: > The @xref command is meant to be used at the beginning of a sentence > because its expansion creates a "See " prefix. The @pxref expands with > a prefix of "see " and is meant to be used within parenthesis. This also > fixes an issue where there was a repeated "see" in the output. I'm not quite convinced this is correct. The original looks like this when viewed in info(1): It will read all configuration scripts as if booting directly (see *Note Loading an operating system directly::). With your patch applied it looks like this: It will read all configuration scripts as if booting directly (*note Loading an operating system directly::). According to Texinfo docs on @pxref [1], it will expand out to "see [...]" in a printed manual only. It even recommends using this to make it clear (and visible in info) that "see" is part of the rendered text: see @ref{node-name} >=20 > Reported-by: Olaf Hering > Signed-off-by: Glenn Washburn > --- > docs/grub.texi | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) >=20 > diff --git a/docs/grub.texi b/docs/grub.texi > index 61e9a0e9ebf8..8da5c3f359c5 100644 > --- a/docs/grub.texi > +++ b/docs/grub.texi > @@ -956,7 +956,7 @@ information. > @subsection Kexec with grub2-emu > =20 > GRUB can be run in userspace by invoking the grub2-emu tool. It will > -read all configuration scripts as if booting directly (see @xref{Loading > +read all configuration scripts as if booting directly (@pxref{Loading Making this "see @ref" instead of "@pxref" keeps the "see" when viewed in info and hopefully also fixes Olaf's "@xref in parentheses" issue: It will read all configuration scripts as if booting directly (see *note Loading an operating system directly::). - Oskari [1]: https://www.gnu.org/software/texinfo/manual/texinfo-html/_0040pxref.ht= ml --Njdg9bRx3OVlFZ7+ Content-Type: application/pgp-signature; name="signature.asc" -----BEGIN PGP SIGNATURE----- iHUEABYIAB0WIQQfOU+JeXjo4uxN6vCp8he9GGIfEQUCZOFzEgAKCRCp8he9GGIf EV8WAQDQYbYh/zq6t/tROpBujpRG3zRa2dwNU8ZUuuntvufFAwD9HLTHMJu62jfJ ckiYlDj7Xqnbqq/MT133/nb/pIUzqwQ= =gjVI -----END PGP SIGNATURE----- --Njdg9bRx3OVlFZ7+-- --===============2926893704785003190== Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: base64 Content-Disposition: inline X19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX19fX18KR3J1Yi1kZXZl bCBtYWlsaW5nIGxpc3QKR3J1Yi1kZXZlbEBnbnUub3JnCmh0dHBzOi8vbGlzdHMuZ251Lm9yZy9t YWlsbWFuL2xpc3RpbmZvL2dydWItZGV2ZWwK --===============2926893704785003190==--