[DOCUMENTATION] [PATCH] doc: Suggest guile-readline and guile-colorized.

  • Done
  • quality assurance status badge
Details
3 participants
  • Ludovic Courtès
  • mirai
  • zimoun
Owner
unassigned
Submitted by
mirai
Severity
normal
M
[PATCH] doc: Suggest guile-readline and guile-colorized.
(address . guix-patches@gnu.org)(name . Bruno Victal)(address . mirai@makinata.eu)
0c0dad2622d0377c4022cd7e8663cf0bad0c8be1.1669774979.git.mirai@makinata.eu
From: Bruno Victal <mirai@makinata.eu>

Allows for a smoother experience with './pre-inst-env guix repl'.

* doc/contributing.texi (Building from Git): Suggest guile-readline and guile-colorized.
---
doc/contributing.texi | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)

Toggle diff (17 lines)
diff --git a/doc/contributing.texi b/doc/contributing.texi
index 40ae33ecac..b5831c5474 100644
--- a/doc/contributing.texi
+++ b/doc/contributing.texi
@@ -96,7 +96,7 @@ On Guix, extra dependencies can be added by instead running @command{guix
shell}:
@example
-guix shell -D guix help2man git strace --pure
+guix shell -D guix help2man git strace guile-readline guile-colorized --pure
@end example
From there you can generate the build system infrastructure

base-commit: aaf1f18b8044142515ff868bcbd2b72b81ced3ec
--
2.38.1
Z
Z
zimoun wrote on 30 Nov 2022 09:37
(name . Bruno Victal)(address . mirai@makinata.eu)
86lens6dnz.fsf@gmail.com
Hi,

On Wed, 30 Nov 2022 at 02:23, mirai@makinata.eu wrote:

Toggle quote (2 lines)
> +guix shell -D guix help2man git strace guile-readline guile-colorized --pure

The package guile-readline requires to be activated, no?
For guile-colorized, never used. :-)

On one hand, I agree that smoothing the experience with “guix repl” is
worth. On the other hand, I think it better to reduce the barrier by
suggesting out-of-the-box packages in the Contributing section.

Well, instead, I am proposing to put this recommendation in this other
section (guix) The Perfect Setup. For example, better worded :-)

Toggle snippet (18 lines)
The Perfect Setup to hack on Guix is basically the perfect setup used
for Guile hacking (*note (guile)Using Guile in Emacs::). First, the
experience is smooth when the packages guile-readline and
guile-colorized are installed and configured. We recommend this
~/.guile,

(use-modules
(ice-9 readline)
(ice-9 format)
(ice-9 pretty-print))
(activate-readline)

Then, you need more than an editor, you need Emacs
(https://www.gnu.org/software/emacs), empowered by the wonderful Geiser
(https://nongnu.org/geiser/). To set that up, run:


WDYT?

Cheers,
simon
M
a35976a3-9527-dea0-4c39-f70134eb4445@makinata.eu
On 2022-11-30 08:37, zimoun wrote:
Toggle quote (2 lines)
> The package guile-readline requires to be activated, no?

Right.

Toggle quote (2 lines)
> For guile-colorized, never used. ?

For guile-colorized, it's automatic.

Toggle quote (3 lines)
> Well, instead, I am proposing to put this recommendation in this other
> section (guix) The Perfect Setup. For example, better worded ?

I'd say that both your snippet and the package recommendations should
be added else one would end up wondering why their './pre-inst-env guix repl'
doesn't pick up the guile extensions when doing so from the guix shell.


Thoughts?

Cheers,
Bruno
M
M
mirai wrote on 2 Dec 2022 19:59
9e6f2da7-49e5-ddcb-0cd6-78e53f4fcfc8@makinata.eu
I've noticed that 9.14 "Using Guix Interactively"[1] already makes this recommendation.


On 2022-11-30 08:37, zimoun wrote:
Toggle quote (39 lines)
> Hi,
>
> On Wed, 30 Nov 2022 at 02:23, mirai@makinata.eu wrote:
>
>> +guix shell -D guix help2man git strace guile-readline guile-colorized --pure
>
> The package guile-readline requires to be activated, no?
> For guile-colorized, never used. :-)
>
> On one hand, I agree that smoothing the experience with “guix repl” is
> worth. On the other hand, I think it better to reduce the barrier by
> suggesting out-of-the-box packages in the Contributing section.
>
> Well, instead, I am proposing to put this recommendation in this other
> section (guix) The Perfect Setup. For example, better worded :-)
>
> --8<---------------cut here---------------start------------->8---
> The Perfect Setup to hack on Guix is basically the perfect setup used
> for Guile hacking (*note (guile)Using Guile in Emacs::). First, the
> experience is smooth when the packages guile-readline and
> guile-colorized are installed and configured. We recommend this
> ~/.guile,
>
> (use-modules
> (ice-9 readline)
> (ice-9 format)
> (ice-9 pretty-print))
> (activate-readline)
>
> Then, you need more than an editor, you need Emacs
> (https://www.gnu.org/software/emacs), empowered by the wonderful Geiser
> (https://nongnu.org/geiser/). To set that up, run:
> --8<---------------cut here---------------end--------------->8---
>
>
> WDYT?
>
> Cheers,
> simon
M
M
mirai wrote on 7 Dec 2022 00:56
(no subject)
(name . control)(address . control@debbugs.gnu.org)
0c5193c7-ab27-27f2-95fd-ba6ca4eb17b6@makinata.eu
retitle 59699 [DOCUMENTATION] [PATCH] doc: Fix formatting for 'computed-file'.
retitle 59700 [DOCUMENTATION] [PATCH] doc: Move %facebook-host-aliases to operating-system.
retitle 59712 [DOCUMENTATION] [PATCH] doc: Suggest guile-readline and guile-colorized.
quit
L
L
Ludovic Courtès wrote on 14 Dec 2022 12:39
Re: bug#59712: [DOCUMENTATION] [PATCH] doc: Suggest guile-readline and guile-colorized.
(address . mirai@makinata.eu)
87sfhirz85.fsf@gnu.org
Hi!

mirai@makinata.eu skribis:

Toggle quote (6 lines)
> From: Bruno Victal <mirai@makinata.eu>
>
> Allows for a smoother experience with './pre-inst-env guix repl'.
>
> * doc/contributing.texi (Building from Git): Suggest guile-readline and guile-colorized.

Is this the right place? Currently both are recommended under “Using
Guix Interactively”, which I think is more appropriate. But maybe we
should add a cross-reference?

To complement what zimoun wrote, the ‘.guile’ skeleton (that new home
directories get by default) enables both when they’re installed.

All in all, I’m not sure anything’s missing. WDYT?

Ludo’.
Z
Z
zimoun wrote on 14 Dec 2022 14:33
Re: [bug#59712] [PATCH] doc: Suggest guile-readline and guile-colorized.
86cz8mhzyh.fsf@gmail.com
Hi,

On Fri, 02 Dec 2022 at 18:59, mirai <mirai@makinata.eu> wrote:
Toggle quote (2 lines)
> I've noticed that 9.14 "Using Guix Interactively"[1] already makes this recommendation.

Therefore, maybe just a cross-reference will be enough but I do not know
where it seems a good place. WDYT?

Cheers,
simon
M
Re: bug#59712: [DOCUMENTATION] [PATCH] doc: Suggest guile-readline and guile-colorized.
(name . Ludovic Courtès)(address . ludo@gnu.org)
0616d6b2-9182-ab51-f5d3-de63050e26b9@makinata.eu
On 2022-12-14 11:39, Ludovic Courtès wrote:
Toggle quote (18 lines)
> Hi!
>
> mirai@makinata.eu skribis:
>
>> From: Bruno Victal <mirai@makinata.eu>
>>
>> Allows for a smoother experience with './pre-inst-env guix repl'.
>>
>> * doc/contributing.texi (Building from Git): Suggest guile-readline and guile-colorized.
>
> Is this the right place? Currently both are recommended under “Using
> Guix Interactively”, which I think is more appropriate. But maybe we
> should add a cross-reference?
>
> To complement what zimoun wrote, the ‘.guile’ skeleton (that new home
> directories get by default) enables both when they’re installed.
>
> All in all, I’m not sure anything’s missing.
Toggle snippet (13 lines)
# have both guile-colorized or guile-readline already installed either via config.scm or guix install

$ guix shell -D guix help2man git strace --pure
~/src/guix [env]$

# perform ./bootstrap, configure and make

~/src/guix [env]$ ./pre-inst-env guix repl
scheme@(guix-user)> ;; does not have guile-colorized or guile-readline



The inconvenient part here being having to do:

Toggle snippet (7 lines)
CTRL-D
$ guix shell -D guix help2man git strace guile-colorized guile-readline --pure
~/src/guix [env]$

# continue with whatever task was being done before

Z
Z
zimoun wrote on 30 Dec 2022 15:37
Re: [bug#59712] [DOCUMENTATION] [PATCH] doc: Suggest guile-readline and guile-colorized.
(address . 59712@debbugs.gnu.org)
874jtdkle9.fsf@gmail.com
Hi,

On Wed, 28 Dec 2022 at 17:28, mirai <mirai@makinata.eu> wrote:
Toggle quote (44 lines)
> On 2022-12-14 11:39, Ludovic Courtès wrote:
>> Hi!
>>
>> mirai@makinata.eu skribis:
>>
>>> From: Bruno Victal <mirai@makinata.eu>
>>>
>>> Allows for a smoother experience with './pre-inst-env guix repl'.
>>>
>>> * doc/contributing.texi (Building from Git): Suggest guile-readline and guile-colorized.
>>
>> Is this the right place? Currently both are recommended under “Using
>> Guix Interactively”, which I think is more appropriate. But maybe we
>> should add a cross-reference?
>>
>> To complement what zimoun wrote, the ‘.guile’ skeleton (that new home
>> directories get by default) enables both when they’re installed.
>>
>> All in all, I’m not sure anything’s missing.
> --8<---------------cut here---------------start------------->8---
> # have both guile-colorized or guile-readline already installed either via config.scm or guix install
>
> $ guix shell -D guix help2man git strace --pure
> ~/src/guix [env]$
>
> # perform ./bootstrap, configure and make
>
> ~/src/guix [env]$ ./pre-inst-env guix repl
> scheme@(guix-user)> ;; does not have guile-colorized or guile-readline
>
> --8<---------------cut here---------------end--------------->8---
>
>
> The inconvenient part here being having to do:
>
> --8<---------------cut here---------------start------------->8---
> CTRL-D
> $ guix shell -D guix help2man git strace guile-colorized guile-readline --pure
> ~/src/guix [env]$
>
> # continue with whatever task was being done before
>
> --8<---------------cut here---------------end--------------->8---

I agree with Ludo. These guile-colorized and guile-readline
recommendations do not appear to me the right place. As pointed in [1],
maybe I would add a cross-reference.



The command line for Building from Git is,

guix shell -D guix --pure

Then, the manual reads: «On Guix, extra dependencies can be added by
instead running guix shell:

guix shell -D guix help2man git strace --pure

» so I would avoid to overload some extra recommendations here.
Especially when such recommendations require extra configuration.
Maybe a cross-link?

The aim of this section is to explain how to build from Git and it
appears to me better to keep it straight to the point and thus to avoid
too many unrelated details (how to configure “./pre-inst-env guix repl”
for instance). The recommendations of guile-colorized and
guile-readline are about using Guix interactively; therefore it appears
to me better to recommend and explain in the dedicated section.




Cheers,
simon
B
B
Bruno Victal wrote on 9 Jan 2023 02:55
(no subject)
(name . control)(address . control@debbugs.gnu.org)
376a7bf8-fd90-1dcc-cad2-68cfcb624a90@makinata.eu
close 59712
quit

----

After careful considerations, it has been decided that it's not worth extending the package set recommended.

For people looking to play around with guix source for extended amounts of time, it is reasonable to assume that
they will customize their package sets (through manifests, etc.)
?