Skip to content
This repository has been archived by the owner on Jan 30, 2023. It is now read-only.

Commit

Permalink
README: Document --enable-editable and --enable-download-from-upstrea…
Browse files Browse the repository at this point in the history
…m-url
  • Loading branch information
Matthias Koeppe committed Apr 5, 2022
1 parent 42b8e47 commit b46c953
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -280,6 +280,25 @@ in the Installation Guide.

$ ./configure --help

Some notable options for Sage developers are the following:

- Use `./configure --enable-editable` to configure the Sage distribution
to install the Sage library in "develop" ("editable", "in-place") mode
instead of using the Sage library's custom incremental build system.

It has the benefit that to try out changes to Python files, one does not
need to run `./sage -b` any more; restarting Sage is enough. It may also
have benefits in certain develop environments that get confused by
sagelib's custom build system.

Note that in an editable install, the source directory will be cluttered
with build artifacts (but they are `.gitignored`). This is normal.

- Use `./configure --enable-download-from-upstream-url` to allow
downloading packages from their upstream URL if they cannot (yet) be
found on the Sage mirrors. This is useful for trying out ticket branches
that make package upgrades.

9. Optional, but highly recommended: Set some environment variables to
customize the build.

Expand Down

0 comments on commit b46c953

Please sign in to comment.