GNU bug report logs -
#66343
Add more setups to Guix docs
Previous Next
Reported by: Ekaitz Zarraga <ekaitz <at> elenq.tech>
Date: Wed, 4 Oct 2023 15:37:02 UTC
Severity: normal
Done: Efraim Flashner <efraim <at> flashner.co.il>
Bug is archived. No further changes may be made.
To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 66343 in the body.
You can then email your comments to 66343 AT debbugs.gnu.org in the normal way.
Toggle the display of automated, internal messages from the tracker.
Report forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Wed, 04 Oct 2023 15:37:02 GMT)
Full text and
rfc822 format available.
Acknowledgement sent
to
Ekaitz Zarraga <ekaitz <at> elenq.tech>:
New bug report received and forwarded. Copy sent to
guix-patches <at> gnu.org.
(Wed, 04 Oct 2023 15:37:02 GMT)
Full text and
rfc822 format available.
Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
------- Original Message -------
On Wednesday, October 4th, 2023 at 15:27, Ludovic Courtès <ludo <at> gnu.org> wrote:
> Hi,
>
> Ekaitz Zarraga ekaitz <at> elenq.tech skribis:
>
> > From 0c2be98f05bb288699a8e39dcef6428eb5a9dc3f Mon Sep 17 00:00:00 2001
> > Message-ID: 0c2be98f05bb288699a8e39dcef6428eb5a9dc3f.1695679042.git.ekaitz <at> elenq.tech
> > From: Ekaitz Zarraga ekaitz <at> elenq.tech
> > Date: Mon, 25 Sep 2023 16:16:28 +0200
> > Subject: [PATCH] WIP: doc: contributing: Add alternative setups section
> >
> > Start with Guile Studio and Vim/NeoVim.
> >
> > * doc/contributing.texi (Alternative Setups): Add section explaining
> > other setups that are similar to the one in The Perfect Setup
>
>
> Not a maintainer either but I like it!
>
> > +@node Alternative Setups
> > +
>
>
> I think you’re missing an @section here.
>
> > +@node Vim and NeoVim
> > +@subsection Vim and Neovim
>
>
> Which spelling is the right one? :-)
>
> Maybe send it to guix-patches <at> gnu.org so it passes on everyone’s radar,
> but otherwise LGTM!
>
> Ludo’.
Great!
Thanks Ludo.
Fixed!
I add guix-patches in the loop.
Thanks all,
Ekaitz
[0001-doc-contributing-Add-alternative-setups-section.patch (text/x-patch, attachment)]
Information forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Wed, 04 Oct 2023 16:19:02 GMT)
Full text and
rfc822 format available.
Message #8 received at 66343 <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
I think we can mention guix.vim also
On Wed, Oct 04, 2023 at 03:36:18PM +0000, Ekaitz Zarraga wrote:
>
> ------- Original Message -------
> On Wednesday, October 4th, 2023 at 15:27, Ludovic Courtès <ludo <at> gnu.org> wrote:
>
>
> > Hi,
> >
> > Ekaitz Zarraga ekaitz <at> elenq.tech skribis:
> >
> > > From 0c2be98f05bb288699a8e39dcef6428eb5a9dc3f Mon Sep 17 00:00:00 2001
> > > Message-ID: 0c2be98f05bb288699a8e39dcef6428eb5a9dc3f.1695679042.git.ekaitz <at> elenq.tech
> > > From: Ekaitz Zarraga ekaitz <at> elenq.tech
> > > Date: Mon, 25 Sep 2023 16:16:28 +0200
> > > Subject: [PATCH] WIP: doc: contributing: Add alternative setups section
> > >
> > > Start with Guile Studio and Vim/NeoVim.
> > >
> > > * doc/contributing.texi (Alternative Setups): Add section explaining
> > > other setups that are similar to the one in The Perfect Setup
> >
> >
> > Not a maintainer either but I like it!
> >
> > > +@node Alternative Setups
> > > +
> >
> >
> > I think you’re missing an @section here.
> >
> > > +@node Vim and NeoVim
> > > +@subsection Vim and Neovim
> >
> >
> > Which spelling is the right one? :-)
> >
> > Maybe send it to guix-patches <at> gnu.org so it passes on everyone’s radar,
> > but otherwise LGTM!
> >
> > Ludo’.
>
> Great!
> Thanks Ludo.
>
> Fixed!
>
> I add guix-patches in the loop.
>
> Thanks all,
> Ekaitz
> From 8ea037b7d8f3472323682594266f5810fd87f291 Mon Sep 17 00:00:00 2001
> Message-ID: <8ea037b7d8f3472323682594266f5810fd87f291.1696433643.git.ekaitz <at> elenq.tech>
> From: Ekaitz Zarraga <ekaitz <at> elenq.tech>
> Date: Mon, 25 Sep 2023 16:16:28 +0200
> Subject: [PATCH] doc: contributing: Add alternative setups section
>
> Start with Guile Studio and Vim/NeoVim.
>
> * doc/contributing.texi (Alternative Setups): Add section explaining
> other setups that are similar to the one in The Perfect Setup
> ---
> doc/contributing.texi | 77 +++++++++++++++++++++++++++++++++++++++----
> 1 file changed, 70 insertions(+), 7 deletions(-)
>
> diff --git a/doc/contributing.texi b/doc/contributing.texi
> index 0de47a403b..c476097bf5 100644
> --- a/doc/contributing.texi
> +++ b/doc/contributing.texi
> @@ -23,6 +23,7 @@ Contributing
> * Building from Git:: The latest and greatest.
> * Running Guix Before It Is Installed:: Hacker tricks.
> * The Perfect Setup:: The right tools.
> +* Alternative Setups:: Other posible tools that do the job.
> * Packaging Guidelines:: Growing the distribution.
> * Coding Style:: Hygiene of the contributor.
> * Submitting Patches:: Share your work.
> @@ -453,6 +454,75 @@ The Perfect Setup
> Emacs Manual} and @ref{Minor Mode,,, debbugs-ug, The Debbugs User
> Guide}.
>
> +@node Alternative Setups
> +@section Alternative Setups
> +
> +Alternative setups than Emacs may let you work on Guix with a
> +similar development experience and they might work better with the
> +tools you currently use or help you make the transition to Emacs.
> +
> +The options listed below only provide the alternatives to the Emacs
> +based setup, which is the most widely used in the Guix community. If
> +you want to really understand how is the perfect setup for Guix
> +development supposed to work, we encourage you to read the section
> +before this regardless the editor you choose to use.
> +
> +@menu
> +* Guile Studio:: First step in your transition to Emacs.
> +* Vim and NeoVim:: When you are evil to the root.
> +@end menu
> +
> +@node Guile Studio
> +@subsection Guile Studio
> +
> +Guile Studio is a pre-configured Emacs with mostly everything you need
> +to start hacking in Guile. If you are not familiar with Emacs it makes
> +the transition easier for you.
> +
> +@example
> +guix install guile-studio
> +@end example
> +
> +Guile Studio comes with Geiser preinstalled and prepared for action.
> +
> +@node Vim and NeoVim
> +@subsection Vim and NeoVim
> +
> +
> +Vim (and NeoVim) are also packaged in Guix, just in case you decided
> +to go for the evil path.
> +
> +@example
> +guix install vim
> +@end example
> +
> +If you want to enjoy a similar development experience to that in the perfect
> +setup, you should install several plugins to configure the editor. Vim (and
> +NeoVim) have the equivalent to Paredit,
> +@uref{https://www.vim.org/scripts/script.php?script_id=3998,
> +@code{paredit.vim}}, that will help you with the structural editing of Scheme
> +files (the support for very large files is not great, though).
> +
> +@example
> +guix install vim-paredit
> +@end example
> +
> +We also recommend that you run @code{:set autoindent} so that your code is
> +automatically indented as you type.
> +
> +For the interaction with Git,
> +@uref{https://www.vim.org/scripts/script.php?script_id=2975
> +@code{fugitive.vim}} is the most commonly used plugin:
> +
> +@example
> +guix install vim-fugitive
> +@end example
> +
And of course if you want to interact with Guix directly from inside of
vim, using the built-in terminal emulator, we have our very own
@code{guix.vim} package!
@example
guix install vim-guix-vim
@end example
> +In NeoVim you can even make a similar setup to Geiser using
> +@url{https://conjure.fun/, Conjure} that lets you connect to a running Guile
> +process and inject your code there live (sadly it's not packaged in Guix yet).
> +
> +
> @node Packaging Guidelines
> @section Packaging Guidelines
>
> @@ -1257,13 +1327,6 @@ Formatting Code
> @noindent
> @xref{Invoking guix style}, for more information.
>
> -@cindex Vim, Scheme code editing
> -If you are editing code with Vim, we recommend that you run @code{:set
> -autoindent} so that your code is automatically indented as you type.
> -Additionally,
> -@uref{https://www.vim.org/scripts/script.php?script_id=3998,
> -@code{paredit.vim}} may help you deal with all these parentheses.
> -
> We require all top-level procedures to carry a docstring. This
> requirement can be relaxed for simple private procedures in the
> @code{(guix build @dots{})} name space, though.
>
> base-commit: 284f8508bebcae510261c7c223dc28f9badf87ce
> --
> 2.41.0
>
--
Efraim Flashner <efraim <at> flashner.co.il> רנשלפ םירפא
GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted
[signature.asc (application/pgp-signature, inline)]
Information forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Wed, 04 Oct 2023 18:17:01 GMT)
Full text and
rfc822 format available.
Message #11 received at 66343 <at> debbugs.gnu.org (full text, mbox):
------- Original Message -------
On Wednesday, October 4th, 2023 at 16:18, Efraim Flashner <efraim <at> flashner.co.il> wrote:
> I think we can mention guix.vim also
Certainly, do you want to add it yourself?
Nobody is going to explain it better than you.
:)
Information forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Wed, 04 Oct 2023 18:37:02 GMT)
Full text and
rfc822 format available.
Message #14 received at 66343 <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
On Wed, Oct 04, 2023 at 06:15:53PM +0000, Ekaitz Zarraga wrote:
>
>
> ------- Original Message -------
> On Wednesday, October 4th, 2023 at 16:18, Efraim Flashner <efraim <at> flashner.co.il> wrote:
>
>
> > I think we can mention guix.vim also
>
>
> Certainly, do you want to add it yourself?
>
> Nobody is going to explain it better than you.
I tossed in a line or two in the middle of the patch
--
Efraim Flashner <efraim <at> flashner.co.il> רנשלפ םירפא
GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted
[signature.asc (application/pgp-signature, inline)]
Information forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Wed, 04 Oct 2023 18:49:02 GMT)
Full text and
rfc822 format available.
Message #17 received at 66343 <at> debbugs.gnu.org (full text, mbox):
------- Original Message -------
On Wednesday, October 4th, 2023 at 18:35, Efraim Flashner <efraim <at> flashner.co.il> wrote:
> On Wed, Oct 04, 2023 at 06:15:53PM +0000, Ekaitz Zarraga wrote:
>
> > ------- Original Message -------
> > On Wednesday, October 4th, 2023 at 16:18, Efraim Flashner efraim <at> flashner.co.il wrote:
> >
> > > I think we can mention guix.vim also
> >
> > Certainly, do you want to add it yourself?
> >
> > Nobody is going to explain it better than you.
>
>
> I tossed in a line or two in the middle of the patch
But you didn't attach, did you?
Or you directly commited?
Information forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Wed, 04 Oct 2023 20:53:02 GMT)
Full text and
rfc822 format available.
Message #20 received at 66343 <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
On Wed, Oct 04, 2023 at 06:47:51PM +0000, Ekaitz Zarraga wrote:
>
> ------- Original Message -------
> On Wednesday, October 4th, 2023 at 18:35, Efraim Flashner <efraim <at> flashner.co.il> wrote:
>
>
> > On Wed, Oct 04, 2023 at 06:15:53PM +0000, Ekaitz Zarraga wrote:
> >
> > > ------- Original Message -------
> > > On Wednesday, October 4th, 2023 at 16:18, Efraim Flashner efraim <at> flashner.co.il wrote:
> > >
> > > > I think we can mention guix.vim also
> > >
> > > Certainly, do you want to add it yourself?
> > >
> > > Nobody is going to explain it better than you.
> >
> >
> > I tossed in a line or two in the middle of the patch
>
> But you didn't attach, did you?
>
> Or you directly commited?
I commented directly in the middle of the patch.
> +@example
> +guix install vim-fugitive
> +@end example
> +
And of course if you want to interact with Guix directly from inside of
vim, using the built-in terminal emulator, we have our very own
@code{guix.vim} package!
@example
guix install vim-guix-vim
@end example
> +In NeoVim you can even make a similar setup to Geiser using
> +@url{https://conjure.fun/, Conjure} that lets you connect to a running Guile
--
Efraim Flashner <efraim <at> flashner.co.il> רנשלפ םירפא
GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted
[v2-0001-doc-contributing-Add-alternative-setups-section.patch (text/plain, attachment)]
[signature.asc (application/pgp-signature, inline)]
Information forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Wed, 04 Oct 2023 20:57:02 GMT)
Full text and
rfc822 format available.
Message #23 received at 66343 <at> debbugs.gnu.org (full text, mbox):
ElenQ Technology
------- Original Message -------
On Wednesday, October 4th, 2023 at 20:51, Efraim Flashner <efraim <at> flashner.co.il> wrote:
> On Wed, Oct 04, 2023 at 06:47:51PM +0000, Ekaitz Zarraga wrote:
>
> > ------- Original Message -------
> > On Wednesday, October 4th, 2023 at 18:35, Efraim Flashner efraim <at> flashner.co.il wrote:
> >
> > > On Wed, Oct 04, 2023 at 06:15:53PM +0000, Ekaitz Zarraga wrote:
> > >
> > > > ------- Original Message -------
> > > > On Wednesday, October 4th, 2023 at 16:18, Efraim Flashner efraim <at> flashner.co.il wrote:
> > > >
> > > > > I think we can mention guix.vim also
> > > >
> > > > Certainly, do you want to add it yourself?
> > > >
> > > > Nobody is going to explain it better than you.
> > >
> > > I tossed in a line or two in the middle of the patch
> >
> > But you didn't attach, did you?
> >
> > Or you directly commited?
>
>
> I commented directly in the middle of the patch.
>
> > +@example
> > +guix install vim-fugitive
> > +@end example
> > +
>
>
> And of course if you want to interact with Guix directly from inside of
> vim, using the built-in terminal emulator, we have our very own
> @code{guix.vim} package!
>
> @example
> guix install vim-guix-vim
> @end example
>
> > +In NeoVim you can even make a similar setup to Geiser using
> > +@url{https://conjure.fun/, Conjure} that lets you connect to a running Guile
>
>
> --
> Efraim Flashner efraim <at> flashner.co.il רנשלפ םירפא
>
> GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351
> Confidentiality cannot be guaranteed on emails sent or received unencrypted
It looks good to me.
Commit?
Reply sent
to
Efraim Flashner <efraim <at> flashner.co.il>:
You have taken responsibility.
(Thu, 05 Oct 2023 12:08:02 GMT)
Full text and
rfc822 format available.
Notification sent
to
Ekaitz Zarraga <ekaitz <at> elenq.tech>:
bug acknowledged by developer.
(Thu, 05 Oct 2023 12:08:02 GMT)
Full text and
rfc822 format available.
Message #28 received at 66343-done <at> debbugs.gnu.org (full text, mbox):
[Message part 1 (text/plain, inline)]
On Wed, Oct 04, 2023 at 08:55:32PM +0000, Ekaitz Zarraga wrote:
>
> It looks good to me.
>
> Commit?
Looks good to me too. Patch pushed!
--
Efraim Flashner <efraim <at> flashner.co.il> רנשלפ םירפא
GPG key = A28B F40C 3E55 1372 662D 14F7 41AA E7DC CA3D 8351
Confidentiality cannot be guaranteed on emails sent or received unencrypted
[signature.asc (application/pgp-signature, inline)]
Information forwarded
to
guix-patches <at> gnu.org:
bug#66343; Package
guix-patches.
(Thu, 05 Oct 2023 12:14:01 GMT)
Full text and
rfc822 format available.
Message #31 received at 66343-done <at> debbugs.gnu.org (full text, mbox):
Thank you all for the collaboration!
bug archived.
Request was from
Debbugs Internal Request <help-debbugs <at> gnu.org>
to
internal_control <at> debbugs.gnu.org.
(Fri, 03 Nov 2023 11:24:11 GMT)
Full text and
rfc822 format available.
This bug report was last modified 1 year and 281 days ago.
Previous Next
GNU bug tracking system
Copyright (C) 1999 Darren O. Benham,
1997,2003 nCipher Corporation Ltd,
1994-97 Ian Jackson.