bug#35942: guix install: environment variable message is very confusing

bug#35942: guix install: environment variable message is very confusing

[Robert Vollmert]

When installing a package that needs an environment variaible to be set for
use, `guix install` prints e.g.:

$ guix install python
...
The following environment variable definitions may be needed:
   export PYTHONPATH="/home/rob/.guix-profile/lib/python3.7/site-packages${PYTHONPATH:+:}$PYTHONPATH"

I understand that the variable will be set in a new shell, but not in the current shell.
But as it stands, the message serves to confuse even users that are somewhat experienced
with unix-like systems.

Suggestion to instead print:

Set the following environment variables to use <package> right away:
   export PYTHONPATH="/home/rob/.guix-profile/lib/python3.7/site-packages${PYTHONPATH:+:}$PYTHONPATH"

bug#35942: guix install: environment variable message is very confusing

[Tobias Geerinckx-Rice]

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

Robert,

Robert Vollmert wrote:
> Suggestion to instead print:
>
> Set the following environment variables to use <package> right 
> away:

Thanks for the bug report!  Related (not duplicate) thread:

<https://lists.gnu.org/archive/html/guix-devel/2019-02/msg00362.html>

Kind regards,

T G-R

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

bug#35942: guix install: environment variable message is very confusing

[Ludovic Courtès]

Hi,

Tobias Geerinckx-Rice <me@tobias.gr> skribis:

> Robert Vollmert wrote:
>> Suggestion to instead print:
>>
>> Set the following environment variables to use <package> right away:
>
> Thanks for the bug report!  Related (not duplicate) thread:
>
> <https://lists.gnu.org/archive/html/guix-devel/2019-02/msg00362.html>

I don’t think we reached a conclusion back then.  I’m fine with Robert’s
suggestion, but do people think it will really help?

Others were in favor of dropping this message altogether, which I think
wouldn’t be a good idea: how would people discover about search path
handling?

Thoughts?

Ludo’.

bug#35942: guix install: environment variable message is very confusing

[Ricardo Wurmus]

Ludovic Courtès <ludo@gnu.org> writes:

> Hi,
>
> Tobias Geerinckx-Rice <me@tobias.gr> skribis:
>
>> Robert Vollmert wrote:
>>> Suggestion to instead print:
>>>
>>> Set the following environment variables to use <package> right away:
>>
>> Thanks for the bug report!  Related (not duplicate) thread:
>>
>> <https://lists.gnu.org/archive/html/guix-devel/2019-02/msg00362.html>
>
> I don’t think we reached a conclusion back then.  I’m fine with Robert’s
> suggestion, but do people think it will really help?
>
> Others were in favor of dropping this message altogether, which I think
> wouldn’t be a good idea: how would people discover about search path
> handling?

I was in favour of *replacing* the message with the suggestion to run

   export GUIX_PROFILE=/this/profile
   source $GUIX_PROFILE/etc/profile

because it usually does the right thing.

It looks less overwhelming than the individual list of environment
variables.  I’ve seen a lot of people who added all of these variables
to their bashrc (or bash_profile if they talked to me before), which is
not what we want to encourage.

We can also hint at “guix package --search-paths” to see a full list of
environment variables for people who want to set them manually right
here and now.

--
Ricardo

bug#35942: guix install: environment variable message is very confusing

[Andreas Enge]

Hello,

On Thu, May 30, 2019 at 09:07:30AM +0200, Ricardo Wurmus wrote:
> I was in favour of *replacing* the message with the suggestion to run
>    export GUIX_PROFILE=/this/profile
>    source $GUIX_PROFILE/etc/profile
> because it usually does the right thing.

I think this was the conclusion reached, and am just waiting for Guix to
give me the message to update one of my bash* files :-)

Andreas

bug#35942: guix install: environment variable message is very confusing

[Ludovic Courtès]

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

Hi!

Ricardo Wurmus <rekado@elephly.net> skribis:

> Ludovic Courtès <ludo@gnu.org> writes:

[...]

>>> <https://lists.gnu.org/archive/html/guix-devel/2019-02/msg00362.html>
>>
>> I don’t think we reached a conclusion back then.  I’m fine with Robert’s
>> suggestion, but do people think it will really help?
>>
>> Others were in favor of dropping this message altogether, which I think
>> wouldn’t be a good idea: how would people discover about search path
>> handling?
>
> I was in favour of *replacing* the message with the suggestion to run
>
>    export GUIX_PROFILE=/this/profile
>    source $GUIX_PROFILE/etc/profile
>
> because it usually does the right thing.
>
> It looks less overwhelming than the individual list of environment
> variables.  I’ve seen a lot of people who added all of these variables
> to their bashrc (or bash_profile if they talked to me before), which is
> not what we want to encourage.
>
> We can also hint at “guix package --search-paths” to see a full list of
> environment variables for people who want to set them manually right
> here and now.

Sounds good to me.

How about the following patch?

It does produce a slightly verbose message, but I don’t think we can do
much better (we could save one line by not mentioning ‘--search-paths’.)

Thanks for getting the ball rolling.  :-)

Ludo’.


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-patch, Size: 2297 bytes --]

diff --git a/guix/scripts/package.scm b/guix/scripts/package.scm
index 06e4cf5b9c..5751123525 100644
--- a/guix/scripts/package.scm
+++ b/guix/scripts/package.scm
@@ -57,7 +57,6 @@
   #:export (build-and-use-profile
             delete-generations
             delete-matching-generations
-            display-search-paths
             guix-package
 
             (%options . %package-options)
@@ -169,8 +168,7 @@ hooks\" run when building the profile."
                               "~a packages in profile~%"
                               count)
                        count)
-               (display-search-paths entries (list profile)
-                                     #:kind 'prefix)))
+               (display-search-path-hint entries profile)))
 
         (warn-about-disk-space profile))))))
 
@@ -289,17 +287,23 @@ symlinks like 'canonicalize-path' would do."
       file
       (string-append (getcwd) "/" file)))
 
-(define* (display-search-paths entries profiles
-                               #:key (kind 'exact))
-  "Display the search path environment variables that may need to be set for
-ENTRIES, a list of manifest entries, in the context of PROFILE."
-  (let* ((profiles (map (compose user-friendly-profile absolutize)
-                        profiles))
-         (settings (search-path-environment-variables entries profiles
-                                                      #:kind kind)))
+(define (display-search-path-hint entries profile)
+  "Display a hint on how to set environment variables to use ENTRIES, a list
+of manifest entries, in the context of PROFILE."
+  (let* ((profile  (user-friendly-profile (absolutize profile)))
+         (settings (search-path-environment-variables entries (list profile)
+                                                      #:kind 'prefix)))
     (unless (null? settings)
-      (format #t (G_ "The following environment variable definitions may be needed:~%"))
-      (format #t "~{   ~a~%~}" settings))))
+      (display-hint (format #f (G_ "Consider setting the necessary environment
+variables by running:
+
+@example
+GUIX_PROFILE=\"~a\"
+. \"$GUIX_PROFILE/etc/profile\"
+@end example
+
+Alternately, see @command{guix package --search-paths -p ~s}.")
+                            profile profile)))))
 
 \f
 ;;;

bug#35942: guix install: environment variable message is very confusing

[Ludovic Courtès]

Hello,

Ludovic Courtès <ludo@gnu.org> skribis:

> How about the following patch?
>
> It does produce a slightly verbose message, but I don’t think we can do
> much better (we could save one line by not mentioning ‘--search-paths’.)

Pushed as bcb7c900cc9d01603fb8fa47bc52caa8e7ebd480.

Feedback welcome!

Thanks,
Ludo’.