Incorrect code snippet in manual

  • Done
  • quality assurance status badge
Details
3 participants
  • Gabriel Hondet
  • John Kehayias
  • Simon Tournier
Owner
unassigned
Submitted by
Gabriel Hondet
Severity
normal

Debbugs page

Gabriel Hondet wrote 1 years ago
(address . bug-guix@gnu.org)
ZRryIlJhNMsYzdhU@eryngii
Hello,

The code snippets of the page 'Sending a patch series' look incorrect to
me: the snippets mention the email address
"guix-patches@debbugs.gnu.org" but the text mentions
"guix-patches@gnu.org".

For instance,
Toggle quote (9 lines)
> We can now send just the cover letter to the guix-patches@gnu.org
> address, which will create an issue that we can send the rest of the
> patches to.
>
> > $ git send-email outgoing/0000-cover-letter.patch -a \
> > --to=guix-patches@debbugs.gnu.org \
> > $(etc/teams.scm cc-members ...)
> > $ rm outgoing/0000-cover-letter.patch # we don't want to resend it!

The documentation I'm looking at is the one accessible at
on the Monday, 2nd of October at 6pm (CEST) (a.k.a. 2023-10-02T18+02:00
if you prefer ISO dates).

Cheers,
Gabriel
-----BEGIN PGP SIGNATURE-----

iQIzBAABCAAdFiEE5ercJXBcjd3P1FcAMbyBBfZZ1CUFAmUa8iIACgkQMbyBBfZZ
1CX6IQ/+PCrpHD1j08vp34q98B868oGyxPjiyu9a7g0tos2Q2SvmLDT1JJP5ubGA
ddXdaprfI179QldYcsAQZsQd2BzynT3MLO7ZinGxZoOK6YIs2zVH07G+zNx0gsHo
xuKY8kQq1wabUyU6sNh8wL+lM5ypW1mVZiZN+0HVw/Td9Jln/3sNaWyvOjp78PUc
YvSeAsqCBecuyoZuG6dwIOUyPpkG0RsBpXiMK+7WxWRVVIRc2EoT1wEr0sAmJ3EO
8ACp3oahoZ6Pcz3uSIxI1uspUzENIwXU6jkpRRbjc5LGUPhPRawEQCRsPoMCpP5X
TbBNNlD9GE23NukuYJWswhXjLxyP1IWFY1Rnac1NGwsN81oxtPZWCFC1VNKi1qVK
Hgag1z3Rcx3p9yMt3qSzr89ghKw9fgMo8O/+IOJXm0zsoTgsrEOfDLL5YC0rl1hR
1JkimgcQPt0igELrD3aGuzFjilKuGciOn7a9/q+D4+7k8KJ1GogD9DSteHculut/
0CnsOsnNm/UfpKSDRz1r0u6hfcWC0OvNklveJePXlRpnzp+6EE01DKqrgTePMRfZ
oNeTbEwyQ8/0t8z76LNRSqjpynBwUTLA2++zmkPHvfqFBc6gOQOz9O7QNz/wYsAi
rgVRm7RoIaKdT60H1TW67PfI0ne41l+DrZ6Gy6aHcFynQHJAYyA=
=xbXM
-----END PGP SIGNATURE-----


John Kehayias wrote 1 years ago
(name . Gabriel Hondet)(address . gabriel.hondet@cominety.net)(address . 66319-done@debbugs.gnu.org)
878r8fahtn.fsf@protonmail.com
Hi Gabriel,

On Mon, Oct 02, 2023 at 06:38 PM, Gabriel Hondet wrote:

Toggle quote (8 lines)
> Hello,
>
> The code snippets of the page 'Sending a patch series' look incorrect to
> me: the snippets mention the email address
> "guix-patches@debbugs.gnu.org" but the text mentions
> "guix-patches@gnu.org".
>

It is possible that one is an alias for the other (I'm not sure), but as
far as I know I always use the guix-patches@gnu.org address to start a
patch submission. After the initial email, as noted in the manual, you
get a bug number @debbugs.gnu.org to use.

Toggle quote (16 lines)
> For instance,
>> We can now send just the cover letter to the guix-patches@gnu.org
>> address, which will create an issue that we can send the rest of the
>> patches to.
>>
>> > $ git send-email outgoing/0000-cover-letter.patch -a \
>> > --to=guix-patches@debbugs.gnu.org \
>> > $(etc/teams.scm cc-members ...)
>> > $ rm outgoing/0000-cover-letter.patch # we don't want to resend it!
>
> The documentation I'm looking at is the one accessible at
> https://guix.gnu.org/manual/en/html_node/Sending-a-Patch-Series.html#Multiple-Patches
> on the Monday, 2nd of October at 6pm (CEST) (a.k.a. 2023-10-02T18+02:00
> if you prefer ISO dates).
>

Ah, so this is the "1.4.0" manual rather than the current one:
This is a long standing confusion that needs to be sorted out, but in
short I would say the 1.4.0 manual is just to match the 1.4.0 installer,
but once installed and updated you should always use the manual that
matches your guix version. You can use "info guix" for instance, or the
web "devel" manual for the latest version.

So, yes, this is a potential error in the 1.4.0 manual but is corrected
in the current version. I don't think we can easily correct the old
version (it is already tagged and released) but we do have to clarify
the manual online for what version is what. This has been reported
before and there are some proposals, not sure why it hasn't been done
yet. Sorry about that!

Toggle quote (3 lines)
> Cheers,
> Gabriel

Hope that is helpful! I'm going to close this in light of the above, but
feel free (or someone else) to reopen if needed.

Thanks for the close reading, doc errors and suggestions always welcome!

John
Closed
Simon Tournier wrote 1 years ago
868r89jviv.fsf@gmail.com
Hi,

On Mon, 02 Oct 2023 at 18:38, Gabriel Hondet via Bug reports for GNU Guix <bug-guix@gnu.org> wrote:

Toggle quote (5 lines)
> The code snippets of the page 'Sending a patch series' look incorrect to
> me: the snippets mention the email address
> "guix-patches@debbugs.gnu.org" but the text mentions
> "guix-patches@gnu.org".

Yes, indeed…

Toggle quote (3 lines)
> The documentation I'm looking at is the one accessible at
> https://guix.gnu.org/manual/en/html_node/Sending-a-Patch-Series.html#Multiple-Patches

…this documentation is frozen for release v1.4.0. The current one is:


where it is fixed, if I read correctly.

Well the origin of your confusion is already tracked by:

bug#51000: The Web manual situation is still needlessly confusing
Tobias Geerinckx-Rice via Bug reports for GNU Guix <bug-guix@gnu.org>
Mon, 04 Oct 2021 00:12:55 +0200
id:87ilydycps.fsf@nckx

Therefore, I am proposing to close. WDYT?

Cheers,
simon
Gabriel Hondet wrote 1 years ago
(address . 66319@debbugs.gnu.org)
ZTFu63pZo_fF7Xnc@eryngii
Hi,

On Wed, Oct 11, 2023 at 12:36:24PM +0200, Simon Tournier wrote:
Toggle quote (32 lines)
> Hi,
>
> On Mon, 02 Oct 2023 at 18:38, Gabriel Hondet via Bug reports for GNU Guix <bug-guix@gnu.org> wrote:
>
> > The code snippets of the page 'Sending a patch series' look incorrect to
> > me: the snippets mention the email address
> > "guix-patches@debbugs.gnu.org" but the text mentions
> > "guix-patches@gnu.org".
>
> Yes, indeed…
>
> > The documentation I'm looking at is the one accessible at
> > https://guix.gnu.org/manual/en/html_node/Sending-a-Patch-Series.html#Multiple-Patches
>
> …this documentation is frozen for release v1.4.0. The current one is:
>
> https://guix.gnu.org/manual/devel/en/guix.html#Sending-a-Patch-Series
>
> where it is fixed, if I read correctly.
>
> Well the origin of your confusion is already tracked by:
>
> bug#51000: The Web manual situation is still needlessly confusing
> Tobias Geerinckx-Rice via Bug reports for GNU Guix <bug-guix@gnu.org>
> Mon, 04 Oct 2021 00:12:55 +0200
> id:87ilydycps.fsf@nckx
> https://issues.guix.gnu.org//51000
> https://issues.guix.gnu.org/msgid/87ilydycps.fsf@nckx
> https://yhetil.org/guix/87ilydycps.fsf@nckx
>
> Therefore, I am proposing to close. WDYT?

No problem with me, this issue won't bring anything new.

Cheers,
Gabriel
-----BEGIN PGP SIGNATURE-----

iQIzBAABCAAdFiEE5ercJXBcjd3P1FcAMbyBBfZZ1CUFAmUxbusACgkQMbyBBfZZ
1CUnpRAAkDnLXCGxzWLE2Ouu10Ibj2c6IFh5RVzSjinw0CLAnXNrxZG0Rgze9RrV
0S8cvEZmQXfUTu8wtjfntFJu2P/dAqYwnxM+MBx9k2Pasz+7GmmmzqR8TT493Pm1
FCWFliO+qUhQmjIhrShD30a2CEQSkc+RTBl06EFdzDCh4NQzoSmuT6g0bLs74Zws
Ob+8yBAUI7DlQYe/V4Zg6CWfRu0a04sHmRgMNi7fOwhpx4f/sT4+vooCjIgCNpGc
c+z6EBWjnS70/wGHErp4pqL3Kxf9jFv8b4uzc7gmUEhHFP0arOjc+wNuyDUQS9Au
tnxvO590RMkSVjI2Rq4eNAxvoBqysmzPFh6rdlvsXh95tm+Ojcuivb2GbwDiCkPs
sbNfhqoFQ9bzdfUyr1KPyjinWE6nwyH70zDFOrntZMnXqzoNQngcTv4yWXGDWNDf
BZ+79/OxMmWS3xppRtGyW35SU7gKYKJepldl7cR6FJbzZRIEjoR0FnBhFJL0/kYc
m8d3tBthyIHVgGYjzAJp7K6OuW1Kt5J9qwepcj6Ajmx1RzJgjsEZDzxec3retmQ2
3HA7uzrrtvpCpimdwlHana6DTld0VyGRV/PfWwvUxG9G8yD7TxLYQVi7wErBi7Zd
7jNxB0jtbQUTNScN4RE8cvvTZDY+4h7N2SRJSLaCaQzOTn1SCEQ=
=A8h/
-----END PGP SIGNATURE-----


Simon Tournier wrote 1 years ago
87pm19moiz.fsf@gmail.com
Hi,

On Thu, 19 Oct 2023 at 20:01, Gabriel Hondet via Bug reports for GNU Guix <bug-guix@gnu.org> wrote:

Toggle quote (4 lines)
>> Therefore, I am proposing to close. WDYT?
>
> No problem with me, this issue won't bring anything new.

Closing.

Thanks,
simon
Closed
?
Your comment

This issue is archived.

To comment on this conversation send an email to 66319@debbugs.gnu.org

To respond to this issue using the mumi CLI, first switch to it
mumi current 66319
Then, you may apply the latest patchset in this issue (with sign off)
mumi am -- -s
Or, compose a reply to this issue
mumi compose
Or, send patches to this issue
mumi send-email *.patch
You may also tag this issue. See list of standard tags. For example, to set the confirmed and easy tags
mumi command -t +confirmed -t +easy
Or, remove the moreinfo tag and set the help tag
mumi command -t -moreinfo -t +help