src/bin/sage-env: Make SAGE_ROOT and SAGE_LOCAL optional

[mkoeppe]

We make SAGE_ROOT and SAGE_LOCAL optional. If one is unset, we skip setting the various environment variables that depend on it.

This change hopefully simplifies distribution packaging, with the goal of allowing unmodified scripts src/bin/sage and src/bin/sage-env to be shipped.

See also:

• src/bin/sage-env: Make sure $SAGE_VENV/bin is at the beginning of the PATH #30013 src/bin/sage-env: Make sure SAGE_SCRIPTS_DIR is at the beginning of the PATH
• Install sage-env-config as part of sage_conf #29850 Install sage-env-config as part of sage_conf; make sage-env-config optional
• Meta-ticket Meta-ticket: Split sage-env into 5 to clean up sage configuration #21707: Split sage-env into 5 to clean up sage configuration

CC: @kiwifb @orlitzky @antonio-rojas @isuruf @tobihan @jhpalmieri @jamesjer

Component: scripts

Author: Matthias Koeppe

Branch/Commit: c8e6910

Reviewer: Dima Pasechnik, Jerry James

Issue created by migration from https://trac.sagemath.org/ticket/29951

[mkoeppe]

Dependencies: #25486

[mkoeppe]

Changed dependencies from #25486 to #30128

[mkoeppe]

Changed dependencies from #30128 to none

[mkoeppe]

Branch: u/mkoeppe/src_bin_sage_env__make_sage_env_config_and_sage_local_optional

[mkoeppe]

Author: Matthias Koeppe

[mkoeppe]

New commits:

c6ed97f

src/bin/sage-env: Make SAGE_ROOT and SAGE_LOCAL optional

[mkoeppe]

Commit: c6ed97f

[mkoeppe]

comment:10

Needs review.

[mkoeppe]

comment:11

Hoping to get some feedback whether this change is helpful for distribution packaging

[kiwifb]

comment:12

I cannot talk about other distros. I have stopped using and shipping sage-env a while back in Gentoo. I only set the following with a patch in the sage executable these days

• SAGE_STARTUP_FILE
• SAGE_RC_FILE
• SAGE_DEBUG
• SAGE_BROWSER

For the rest, whatever is in env.py or sage_conf.py is enough.

The main issue is that a lot of stuff in there is not that useful at runtime. You need PATH properly set and a few other in case you compile something from inside sage but most of the stuff in sage-env is not useful anymore once at run-time. I guess you may want to load the sage variables if you start sage -sh but that's it.

[antonio-rojas]

comment:13

same here, haven't installed sage-env for a long time

[sagetrac-git]

Changed commit from c6ed97f to 53805b0

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. This was a forced push. New commits:

53805b0

src/bin/sage-env: Make SAGE_ROOT and SAGE_LOCAL optional

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

09584ea

Merge tag '9.2.beta14' into t/29951/src_bin_sage_env__make_sage_env_config_and_sage_local_optional

[sagetrac-git]

Changed commit from 53805b0 to 09584ea

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

a2571b1

Merge tag '9.2' into t/29951/src_bin_sage_env__make_sage_env_config_and_sage_local_optional

[sagetrac-git]

Changed commit from 09584ea to a2571b1

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

9ba8cf2

Merge tag '9.3.beta0' into t/29951/src_bin_sage_env__make_sage_env_config_and_sage_local_optional

[sagetrac-git]

Changed commit from a2571b1 to 9ba8cf2

[mkoeppe]

comment:19

Let's get this in please, as a path toward unpatched installation of sagelib in downstream packaging.

[sagetrac-git]

Changed commit from 9ba8cf2 to c8e6910

[sagetrac-git]

Branch pushed to git repo; I updated commit sha1. New commits:

c8e6910

Merge tag '9.3.beta1' into t/29951/src_bin_sage_env__make_sage_env_config_and_sage_local_optional

[dimpase]

Reviewer: Dima Pasechnik

[dimpase]

comment:22

lgtm

[jamesjer]

comment:24

Thank you for thinking of distribution needs. Speaking for Fedora, I am in favor of this change.

[mkoeppe]

comment:25

Thanks for the review!

[mkoeppe]

Changed reviewer from Dima Pasechnik to Dima Pasechnik, Jerry James

[vbraun]

Changed branch from u/mkoeppe/src_bin_sage_env__make_sage_env_config_and_sage_local_optional to c8e6910