git send-email

git send-email

[Nicolas Débonnaire]

[-- Attachment #1: Type: text/plain, Size: 459 bytes --]

Hi,

In guix documentation we have the following command to send the cover
letter of a patch serie:

git send-email outgoing/0000-cover-letter.patch -a \
      --to=guix-patches@debbugs.gnu.org \
      $(etc/teams.scm cc-members ...)

However, Gmail responded with the following error:

550 Unrouteable address

To solve this issue, I changed the email adress from
guix-patches@debbugs.gnu.org to guix-patches@gnu.org it worked.

Is it a documentation typo ?

[-- Attachment #2: Type: text/html, Size: 1014 bytes --]

Re: git send-email

[Jack Hill]

[-- Attachment #1: Type: text/plain, Size: 639 bytes --]

On Sat, 18 Nov 2023, Nicolas Débonnaire wrote:

> Hi,
> In guix documentation we have the following command to send the cover letter of a patch serie:
> 
> git send-email outgoing/0000-cover-letter.patch -a \
>       --to=guix-patches@debbugs.gnu.org \
>       $(etc/teams.scm cc-members ...)
> 
> However, Gmail responded with the following error:
> 550 Unrouteable address
> To solve this issue, I changed the email adress from guix-patches@debbugs.gnu.org to guix-patches@gnu.org it worked.
> Is it a documentation typo ?

Yes, that looks like a documentation typo to me. Would you like to send a 
patch for that one too?

Thanks!
Jack

Re: git send-email

[Nicolas Débonnaire]

[-- Attachment #1: Type: text/plain, Size: 1122 bytes --]

Well, I just realised there is two version of the manual available and I
was looking at the wrong one from the beginning. (
https://guix.gnu.org/en/manual/)
It looks like it's been fixed in the latest version. (
https://guix.gnu.org/en/manual/devel/)
(sorry for the duplicate mail, I used reply instead of reply all in the
previous mail)

Le sam. 18 nov. 2023 à 18:26, Jack Hill <jackhill@jackhill.us> a écrit :

> On Sat, 18 Nov 2023, Nicolas Débonnaire wrote:
>
> > Hi,
> > In guix documentation we have the following command to send the cover
> letter of a patch serie:
> >
> > git send-email outgoing/0000-cover-letter.patch -a \
> >       --to=guix-patches@debbugs.gnu.org \
> >       $(etc/teams.scm cc-members ...)
> >
> > However, Gmail responded with the following error:
> > 550 Unrouteable address
> > To solve this issue, I changed the email adress from
> guix-patches@debbugs.gnu.org to guix-patches@gnu.org it worked.
> > Is it a documentation typo ?
>
> Yes, that looks like a documentation typo to me. Would you like to send a
> patch for that one too?
>
> Thanks!
> Jack

[-- Attachment #2: Type: text/html, Size: 1852 bytes --]

Re: git send-email

[Philip McGrath]

On Sun, Nov 19, 2023, at 10:59 AM, Nicolas Débonnaire wrote:
> Well, I just realised there is two version of the manual available and I was looking at the wrong one from the beginning. (https://guix.gnu.org/en/manual/)
> It looks like it's been fixed in the latest version. (https://guix.gnu.org/en/manual/devel/)
> (sorry for the duplicate mail, I used reply instead of reply all in the previous mail)
> 

This seems to regularly cause confusion for a lot of people (and has confused me). AIUI, the "devel" manual seems like a misnomer: it is the manual for Guix from the "master" branch, which, unless you never run `guix pull`, is the relevant Guix for almost anything. It's the one that ends up in ~/.config/guix/current.

It's possible to be running daemon that is different from your "current" Guix. If so, AND if you happen to have the daemon from the latest Guix release (as opposed to an older or newer Guix), then the non-"devel" manual would be relevant **for functionality specific to the daemon**. That seems to me like a very specific scenario, and AFAIK it's the only scenario when the non-"devel" manual is relevant.

 1. Can we reorganize things on the website so that the non-"devel" manual is much more prominent than the other one?

 2. I wish there were a Guix package I could install to read the HTML documentation locally.

Re: git send-email

[Felix Lechner via Development of GNU Guix and the GNU System distribution.]

Hi Philip,

On Sun, Nov 19 2023, Philip McGrath wrote:

>  1. Can we reorganize things on the website so that the non-"devel" manual is much more prominent than the other one?

Was the "non" possibly a typo? In my opinion, the non-devel manual
should no longer be published.

Please feel free to chime in under

  https://issues.guix.gnu.org/51000

>  2. I wish there were a Guix package I could install to read the HTML documentation locally.

As an Emacs user, I select "guix" after hitting "C h R". I can search
the index with "i".

A standalone 'info' executable may provide a similarly convenient kind
of local access to the manual.

Kind regards
Felix

Re: git send-email

[Philip McGrath]

Hi,

On Sun, Nov 19, 2023, at 12:27 PM, Felix Lechner wrote:
> Hi Philip,
>
> On Sun, Nov 19 2023, Philip McGrath wrote:
>
>>  1. Can we reorganize things on the website so that the non-"devel" manual is much more prominent than the other one?
>
> Was the "non" possibly a typo? In my opinion, the non-devel manual
> should no longer be published.
>

Yes, a typo, or perhaps another example of how confusing this is!

> Please feel free to chime in under
>
>   https://issues.guix.gnu.org/51000
>
>>  2. I wish there were a Guix package I could install to read the HTML documentation locally.
>
> As an Emacs user, I select "guix" after hitting "C h R". I can search
> the index with "i".
>
> A standalone 'info' executable may provide a similarly convenient kind
> of local access to the manual.
>

I have used the local info version, but I like the HTML version better.

Philip

Re: git send-email

[Matt]

 ---- On Sun, 19 Nov 2023 17:22:47 +0100  Philip McGrath  wrote --- 

 >  2. I wish there were a Guix package I could install to read the HTML documentation locally.

This is probably the simplest way:

1. guix shell wget
2. wget https://guix.gnu.org/manual/en/guix.html

According to the docs (https://guix.gnu.org/en/manual/devel/en/html_node/Writing-Documentation.html), the following should work (but doesn't for me):

1. git clone https://git.savannah.gnu.org/git/guix.git
2. cd guix
3. guix shell -D guix --pure
4. ./bootstrap
5. ./configure --localstatedir=/var --sysconfdir=/etc
6. make doc/guix.html

It fails with:

 MAKEINFO doc/guix.html
guix.texi:16880: @include: could not find os-config-bare-bones.texi
guix.texi:17057: @include: could not find os-config-desktop.texi
guix.texi:17064: @include: could not find os-config-lightweight-desktop.texi
make: *** [Makefile:4988: doc/guix.html] Error 1

It's worth noting that the Writing Documentation page links to Running Guix Before It Is Installed (https://guix.gnu.org/en/manual/devel/en/html_node/Running-Guix-Before-It-Is-Installed.html) when it probably meant to link the previous section Building from Git (https://guix.gnu.org/en/manual/devel/en/html_node/Building-from-Git.html) since it mentions needing to run ./configure first.

My guess is that the above steps will work if you run make before running make doc/guix.html.