bug#36544: 'set-paths' should exclude 'source' from consideration

bug#36544: 'set-paths' should exclude 'source' from consideration

[Mark H Weaver]

The 'set-paths' phase in (guix build gnu-build-system) currently
includes 'source' in the set of candidates for inclusion in the
search-path variables.

First of all, I think it's undesirable to include subdirectories of the
source directory in these search paths.  However, if you think it's
desirable, there's another problem: it's fragile.  It depends on:

 (1) whether the source is a tarball or an unpacked checkout, and
 (2) whether the subdirectories specified in the search-paths
     (e.g. 'include') are within the top source directory.

Currently, if you change the 'source' field of a package from a tarball
to an (unpacked) VCS checkout, there *might* be additional components
added to the environment variables, depending on the source tree layout.

For example, this causes our 'linux-libre' package to fail to build if
you substitute its 'source' field for a git checkout, as Chris Webber
discovered here:

  https://lists.gnu.org/archive/html/help-guix/2019-07/msg00058.html
  https://lists.gnu.org/archive/html/help-guix/2019-07/msg00062.html

Also, if any package depends on the current behavior, it will break if
its 'source' is changed from a VCS checkout to a release tarball.

To avoid this unexpected sensitivity on the source origin method, I
suggest that we explicitly exclude 'source' from consideration within
the 'set-paths' phase.  What do you think?

Also, does anyone know of other procedures that do something similiar?

     Thanks,
       Mark

bug#36544: 'set-paths' should exclude 'source' from consideration

[Ludovic Courtès]

Hello,

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

> The 'set-paths' phase in (guix build gnu-build-system) currently
> includes 'source' in the set of candidates for inclusion in the
> search-path variables.

Oh, that was certainly not intended.

> First of all, I think it's undesirable to include subdirectories of the
> source directory in these search paths.  However, if you think it's
> desirable, there's another problem: it's fragile.  It depends on:
>
>  (1) whether the source is a tarball or an unpacked checkout, and
>  (2) whether the subdirectories specified in the search-paths
>      (e.g. 'include') are within the top source directory.
>
> Currently, if you change the 'source' field of a package from a tarball
> to an (unpacked) VCS checkout, there *might* be additional components
> added to the environment variables, depending on the source tree layout.
>
> For example, this causes our 'linux-libre' package to fail to build if
> you substitute its 'source' field for a git checkout, as Chris Webber
> discovered here:
>
>   https://lists.gnu.org/archive/html/help-guix/2019-07/msg00058.html
>   https://lists.gnu.org/archive/html/help-guix/2019-07/msg00062.html
>
> Also, if any package depends on the current behavior, it will break if
> its 'source' is changed from a VCS checkout to a release tarball.

Indeed, that’s terrible.  I suppose we were just lucky not to hit such
issues before!

> To avoid this unexpected sensitivity on the source origin method, I
> suggest that we explicitly exclude 'source' from consideration within
> the 'set-paths' phase.  What do you think?

I agree.  We should do that in the next ‘core-updates’.

Ludo’.

bug#36544: 'set-paths' should exclude 'source' from consideration

[Leo Famulari]

On Thu, Jul 11, 2019 at 11:24:55PM +0200, Ludovic Courtès wrote:
> > To avoid this unexpected sensitivity on the source origin method, I
> > suggest that we explicitly exclude 'source' from consideration within
> > the 'set-paths' phase.  What do you think?
> 
> I agree.  We should do that in the next ‘core-updates’.

Now is a good time to make this change.

bug#36544: 'set-paths' should exclude 'source' from consideration

[Marius Bakke]

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

Leo Famulari <leo@famulari.name> skriver:

> On Thu, Jul 11, 2019 at 11:24:55PM +0200, Ludovic Courtès wrote:
>> > To avoid this unexpected sensitivity on the source origin method, I
>> > suggest that we explicitly exclude 'source' from consideration within
>> > the 'set-paths' phase.  What do you think?
>> 
>> I agree.  We should do that in the next ‘core-updates’.
>
> Now is a good time to make this change.

This was fixed in 968f541c36c28c413f696558505f902d0a133d58.

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 507 bytes --]

bug#36544: 'set-paths' should exclude 'source' from consideration

[Aiko Kyle]

> > To avoid this unexpected sensitivity on the source origin 
> > method, I
> > suggest that we explicitly exclude 'source' from consideration 
> > within
> > the 'set-paths' phase.  What do you think?
> 
> I agree.  We should do that in the next ‘core-updates’.

I recently ran into this bug myself and was surprised that there 
would be a difference between building from a tarball and a git 
checkout. It seems the fix should be fairly straight forward so 
are there any plans to implement it?

Thanks,
Aiko