[PATCH] doc: Mention update-guix-package in guix-binary tarball, rebuild instructions.

  • Done
  • quality assurance status badge
Details
3 participants
  • Ludovic Courtès
  • Maxim Cournoyer
  • Vincent Legoll
Owner
unassigned
Submitted by
Vincent Legoll
Severity
normal
V
V
Vincent Legoll wrote on 13 Apr 2020 14:34
(address . guix-patches@gnu.org)
0b207bae-2f18-eb06-d51b-0f0c92eb6d15@gmail.com
Hello,

following the discussion in guix-devel, here is a small doc
addition to explain how binary-tarball modifications can
be built and then tested...

WDYT ?

--
Vincent Legoll
From dd961656d9bd98d11ba5e38be89cd1952fefc263 Mon Sep 17 00:00:00 2001
From: Vincent Legoll <vincent.legoll@gmail.com>
Date: Mon, 13 Apr 2020 14:25:57 +0200
Subject: [PATCH] doc: Mention update-guix-package in guix-binary tarball
rebuild instructions.

* doc/guix.texi (Binary Installation): Mention 'make update-guix-package'.
---
doc/guix.texi | 11 +++++++++++
1 file changed, 11 insertions(+)

Toggle diff (31 lines)
diff --git a/doc/guix.texi b/doc/guix.texi
index 891e2693f6..8bf4ef9b74 100644
--- a/doc/guix.texi
+++ b/doc/guix.texi
@@ -77,6 +77,7 @@ Copyright @copyright{} 2020 Jakub K?dzio?ka@*
Copyright @copyright{} 2020 Jack Hill@*
Copyright @copyright{} 2020 Naga Malleswari@*
Copyright @copyright{} 2020 Brice Waegeneire@*
+Copyright @copyright{} 2020 Vincent Legoll@*
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
@@ -736,6 +737,16 @@ guix pack -s @var{system} --localstatedir \
@xref{Invoking guix pack}, for more info on this handy tool.
+If you have local modifications you want to include in the resulting
+tarball, you have to run the following command in your modified Guix
+source tree before doing the above:
+
+@example
+make update-guix-package
+git commit -m'NOT_FOR_UPSTREAM:allow testing a modified guix-binary' \
+ gnu/packages/package-management.scm
+@end example
+
@node Requirements
@section Requirements
--
2.20.1
L
L
Ludovic Courtès wrote on 13 Apr 2020 15:41
(name . Vincent Legoll)(address . vincent.legoll@gmail.com)(address . 40597@debbugs.gnu.org)
87sgh7jyfb.fsf@gnu.org
Hi Vincent,

Vincent Legoll <vincent.legoll@gmail.com> skribis:

Toggle quote (8 lines)
>>From dd961656d9bd98d11ba5e38be89cd1952fefc263 Mon Sep 17 00:00:00 2001
> From: Vincent Legoll <vincent.legoll@gmail.com>
> Date: Mon, 13 Apr 2020 14:25:57 +0200
> Subject: [PATCH] doc: Mention update-guix-package in guix-binary tarball
> rebuild instructions.
>
> * doc/guix.texi (Binary Installation): Mention 'make update-guix-package'.

I agree this needs to be documented, but I don’t think this is the right
place: “Binary Installation” is for users who want to install. Instead,
we should document it in a section explicitly targeting Guix developers,
maybe under “Contributing”?

Thanks,
Ludo’.
V
V
Vincent Legoll wrote on 13 Apr 2020 15:43
(name . Ludovic Courtès)(address . ludo@gnu.org)(address . 40597@debbugs.gnu.org)
91ebc21a-2d35-a51d-c474-799d12db2cca@gmail.com
On 13/04/2020 15:41, Ludovic Courtès wrote:
Toggle quote (8 lines)
> Vincent Legoll <vincent.legoll@gmail.com> skribis:
>
>> * doc/guix.texi (Binary Installation): Mention 'make update-guix-package'.
> I agree this needs to be documented, but I don’t think this is the right
> place: “Binary Installation” is for users who want to install. Instead,
> we should document it in a section explicitly targeting Guix developers,
> maybe under “Contributing”?

OK, I'll see what I can do.

--
Vincent Legoll
L
L
Ludovic Courtès wrote on 25 May 2020 22:14
control message for bug #40597
(address . control@debbugs.gnu.org)
875zcjvkjj.fsf@gnu.org
tags 40597 + moreinfo
quit
M
M
Maxim Cournoyer wrote on 14 Jul 2021 05:19
Re: bug#40597: [PATCH] doc: Mention update-guix-package in guix-binary tarball, rebuild instructions.
(name . Ludovic Courtès)(address . ludo@gnu.org)
87pmvlpop9.fsf_-_@gmail.com
Hi Vincent and Ludovic,

Ludovic Courtès <ludo@gnu.org> writes:

Toggle quote (17 lines)
> Hi Vincent,
>
> Vincent Legoll <vincent.legoll@gmail.com> skribis:
>
>>>>From dd961656d9bd98d11ba5e38be89cd1952fefc263 Mon Sep 17 00:00:00 2001
>> From: Vincent Legoll <vincent.legoll@gmail.com>
>> Date: Mon, 13 Apr 2020 14:25:57 +0200
>> Subject: [PATCH] doc: Mention update-guix-package in guix-binary tarball
>> rebuild instructions.
>>
>> * doc/guix.texi (Binary Installation): Mention 'make update-guix-package'.
>
> I agree this needs to be documented, but I don’t think this is the right
> place: “Binary Installation” is for users who want to install. Instead,
> we should document it in a section explicitly targeting Guix developers,
> maybe under “Contributing”?

A "Updating the Guix Package" subsection has since been added to the
Contributing section, which I believe covers this.

Thank you,

Closing.

Maxim
Closed
?
Your comment

This issue is archived.

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

To respond to this issue using the mumi CLI, first switch to it
mumi current 40597
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