bug#47812: Incorrect code in the Guix manual, but only on the website

bug#47812: Incorrect code in the Guix manual, but only on the website

[Mark H Weaver]

In the Guix manual, as it appears on our website,

  https://guix.gnu.org/manual/devel/en/html_node/X-Window.html

the manual entry for 'slim-service-type' suggests the following code to
remove the 'gdm' service from %desktop-services.

--8<---------------cut here---------------start------------->8---
   (modify-services %desktop-services
     (delete gdm-service-type))
--8<---------------cut here---------------end--------------->8---

This code is incorrect.  'modify-services' does not support deleting
services.

The puzzling thing is that I can't find where this suggested code exists
in our git repository.  The manual in our git repository is correct.
Instead of the code above, it suggests:

--8<---------------cut here---------------start------------->8---
   (remove (lambda (service)
             (eq? (service-kind service) gdm-service-type))
           %desktop-services)
--8<---------------cut here---------------end--------------->8---

This is the case on our 'master', 'core-updates', and 'version-1.2.0'
branches.  See:

  https://git.sv.gnu.org/cgit/guix.git/tree/doc/guix.texi?id=ebd021f73292bf47b26a799665d6204574bae239#n17891
  https://git.sv.gnu.org/cgit/guix.git/tree/doc/guix.texi?h=core-updates&id=76fc36d0a7215979bb74c05840f5a4de4ab5ea93#n17756
  https://git.sv.gnu.org/cgit/guix.git/tree/doc/guix.texi?h=version-1.2.0&id=8603bcd5822a1a8364a7a74a698059d3d147568b#n17076

The correct text was added about 2 years ago, in the following commit:

  https://git.sv.gnu.org/cgit/guix.git/commit/?id=dbef9015db107dd148133420b89af552ef08f8ee

I see no evidence of it being changed since then.

Any idea where the incorrect code on the website manual is coming from?

      Thanks,
        Mark

bug#47812: Incorrect code in the Guix manual, but only on the website

[Mark H Weaver]

Mark H Weaver <mhw@netris.org> writes:

> The correct text was added about 2 years ago, in the following commit:
>
>   https://git.sv.gnu.org/cgit/guix.git/commit/?id=dbef9015db107dd148133420b89af552ef08f8ee
>
> I see no evidence of it being changed since then.
>
> Any idea where the incorrect code on the website manual is coming from?

I see now that this new functionality was added to the 'staging' branch
3 days ago:

  https://git.sv.gnu.org/cgit/guix.git/commit/?h=staging&id=a247f5c7537df7e0c09051ba22d5c95eb08f48b9

It seems inappropriate for our online website manual to be taken from
'staging'.  It has already led to an experienced Guix developer
repeatedly suggesting (to a new user) a code snippet that cannot
possibly work on the 'master' branch:

  https://bugs.gnu.org/47748#14
  https://bugs.gnu.org/47748#41

       Mark

bug#47812: Incorrect code in the Guix manual, but only on the website

[Leo Famulari]

On Thu, Apr 15, 2021 at 08:12:13PM -0400, Mark H Weaver wrote:
> Mark H Weaver <mhw@netris.org> writes:
> 
> > The correct text was added about 2 years ago, in the following commit:
> >
> >   https://git.sv.gnu.org/cgit/guix.git/commit/?id=dbef9015db107dd148133420b89af552ef08f8ee
> >
> > I see no evidence of it being changed since then.
> >
> > Any idea where the incorrect code on the website manual is coming from?
> 
> I see now that this new functionality was added to the 'staging' branch
> 3 days ago:
> 
>   https://git.sv.gnu.org/cgit/guix.git/commit/?h=staging&id=a247f5c7537df7e0c09051ba22d5c95eb08f48b9
> 
> It seems inappropriate for our online website manual to be taken from
> 'staging'.  It has already led to an experienced Guix developer
> repeatedly suggesting (to a new user) a code snippet that cannot
> possibly work on the 'master' branch:

Hm, that's not supposed to happen. It's supposed to be based on the
'master' branch.

bug#47812: Incorrect code in the Guix manual, but only on the website

[Leo Famulari]

On Thu, Apr 15, 2021 at 08:12:13PM -0400, Mark H Weaver wrote:
> I see now that this new functionality was added to the 'staging' branch
> 3 days ago:
> 
>   https://git.sv.gnu.org/cgit/guix.git/commit/?h=staging&id=a247f5c7537df7e0c09051ba22d5c95eb08f48b9

If I understand correctly, this commit is also on the master branch: 

https://git.savannah.gnu.org/cgit/guix.git/commit/?h=master&id=a247f5c7537df7e0c09051ba22d5c95eb08f48b9

And I do see it in my local copy of the repo.

Can you double-check on your end? Or have I misunderstood?

bug#47812: Incorrect code in the Guix manual, but only on the website

[Mark H Weaver]

tags 47812 + notabug
close 47812
thanks

Hi Leo,

Leo Famulari <leo@famulari.name> writes:

> On Thu, Apr 15, 2021 at 08:12:13PM -0400, Mark H Weaver wrote:
>> I see now that this new functionality was added to the 'staging' branch
>> 3 days ago:
>> 
>>   https://git.sv.gnu.org/cgit/guix.git/commit/?h=staging&id=a247f5c7537df7e0c09051ba22d5c95eb08f48b9
>
> If I understand correctly, this commit is also on the master branch: 
>
> https://git.savannah.gnu.org/cgit/guix.git/commit/?h=master&id=a247f5c7537df7e0c09051ba22d5c95eb08f48b9
>
> And I do see it in my local copy of the repo.
>
> Can you double-check on your end? Or have I misunderstood?

No, you're right.  When I first checked, I hadn't updated my local git
repo recently enough to have the commit.  However, I'm not sure how I
managed to include (in my original report) a Savannah URL pointing to
the relevant code without noticing that it had the newly updated code.

I'm closing this bug now.  Sorry for the noise.

     Thanks,
       Mark