Skip to content

Commit

Permalink
Browse files Browse the repository at this point in the history
gh-36415: README: Recommend `configure --config-cache --enable-ccache`
    
<!-- ^^^^^
Please provide a concise, informative and self-explanatory title.
Don't put issue numbers in there, do this in the PR body below.
For example, instead of "Fixes #1234" use "Introduce new method to
calculate 1+1"
-->
<!-- Describe your changes here in detail -->

This can save a bit of time for developers, although only a fraction of
our configure tests are cached.

Also removes mention of  `--enable-download-from-upstream-url`, which
has been the default for a while now.

Also reducing some excessive messages from spkg-configure

<!-- Why is this change required? What problem does it solve? -->
<!-- If this PR resolves an open issue, please link to it here. For
example "Fixes #12345". -->
<!-- If your change requires a documentation PR, please link it
appropriately. -->

### 📝 Checklist

<!-- Put an `x` in all the boxes that apply. -->
<!-- If your change requires a documentation PR, please link it
appropriately -->
<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
<!-- Feel free to remove irrelevant items. -->

- [x] The title is concise, informative, and self-explanatory.
- [x] The description explains in detail what this PR is about.
- [ ] I have linked a relevant issue or discussion.
- [ ] I have created tests covering the changes.
- [ ] I have updated the documentation accordingly.

### ⌛ Dependencies

<!-- List all open PRs that this PR logically depends on
- #12345: short description why this is a dependency
- #34567: ...
-->

<!-- If you're unsure about any of these, don't hesitate to ask. We're
here to help! -->
    
URL: #36415
Reported by: Matthias Köppe
Reviewer(s): Kwankyu Lee, Matthias Köppe
  • Loading branch information
Release Manager committed Oct 11, 2023
2 parents 8327845 + 39db606 commit 472121b
Show file tree
Hide file tree
Showing 5 changed files with 17 additions and 19 deletions.
18 changes: 12 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -319,12 +319,18 @@ in the Installation Guide.

$ ./configure --help

A notable option for Sage developers is the following:

- 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.
Notable options for Sage developers are the following:

- Use the option `--config-cache` to have `configure`
keep a disk cache of configuration values. This gives a nice speedup
when trying out ticket branches that make package upgrades, which
involves automatic re-runs of the configuration step.

- Use the option `--enable-ccache` to have Sage install and use the
optional package `ccache`, which is preconfigured to keep a
disk cache of object files created from source files. This can give
a great speedup when switching between different branches, at the
expense of disk space use.

10. Optional, but highly recommended: Set some environment variables to
customize the build.
Expand Down
11 changes: 4 additions & 7 deletions build/pkgs/glpk/spkg-configure.m4
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,15 @@ SAGE_SPKG_CONFIGURE([glpk], [
glpk_ver=`$GLPSOL --version | grep ^GLPSOL | $SED -e 's/GLPSOL.*ver, v//g' 2>> config.log`
AX_COMPARE_VERSION([$glpk_ver], [ge], [$SAGE_GLPK_MINVER], [
AC_CHECK_HEADER([glpk.h], [], [sage_spkg_install_glpk=yes])
AC_SEARCH_LIBS([glp_config], [glpk],
[AC_MSG_RESULT([yes. Use system's glpk])], [
AC_MSG_RESULT([no. Install glpk])
sage_spkg_install_glpk=yes])dnl end-AC_SEARCH_LIBS
], [sage_spkg_install_glpk=yes])dnl end-AX_COMPARE_VERSION
AC_SEARCH_LIBS([glp_config], [glpk], [], [sage_spkg_install_glpk=yes])dnl end-AC_SEARCH_LIBS
], [sage_spkg_install_glpk=yes])dnl end-AX_COMPARE_VERSION
])dnl end-AS_IF
])
m4_popdef([SAGE_GLPK_MINVER])
], [], [], [
AS_IF([test x$sage_spkg_install_glpk = xyes], [
AC_SUBST(SAGE_GLPK_PREFIX, ['$SAGE_LOCAL'])
AC_MSG_RESULT([using Sage's glpk SPKG])], [
], [
AC_SUBST(SAGE_GLPK_PREFIX, [''])
AC_MSG_RESULT([using glpk from the system])])
])
])
2 changes: 0 additions & 2 deletions build/pkgs/mpc/spkg-configure.m4
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ SAGE_SPKG_CONFIGURE([mpc], [
], [], [], [
if test x$sage_spkg_install_mpc = xyes; then
AC_SUBST(SAGE_MPC_PREFIX, ['$SAGE_LOCAL'])
AC_MSG_RESULT([using Sage's mpc SPKG])
else
AC_SUBST(SAGE_MPC_PREFIX, [''])
AC_MSG_RESULT([using mpc library from the system])
fi
])
2 changes: 0 additions & 2 deletions build/pkgs/mpfr/spkg-configure.m4
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,7 @@ SAGE_SPKG_CONFIGURE([mpfr], [
], [], [], [
if test x$sage_spkg_install_mpfr = xyes; then
AC_SUBST(SAGE_MPFR_PREFIX, ['$SAGE_LOCAL'])
AC_MSG_RESULT([using Sage's mpfr SPKG])
else
AC_SUBST(SAGE_MPFR_PREFIX, [''])
AC_MSG_RESULT([using mpfr library from the system])
fi
])
3 changes: 1 addition & 2 deletions build/pkgs/pkgconf/spkg-configure.m4
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,8 @@ SAGE_SPKG_CONFIGURE(
AS_IF([test -z "$PKG_CONFIG"], [
sage_spkg_install_pkgconf=yes
AC_SUBST(SAGE_PKG_CONFIG_PATH, [''])
AC_MSG_RESULT([installing pkgconf spkg])], [
], [
dnl the following as needed as long as Sage creates .pc files during build and/or configure
AC_SUBST(SAGE_PKG_CONFIG_PATH, ['$SAGE_LOCAL/lib/pkgconfig'])
AC_MSG_RESULT([using pkg-config from the system])
])
])

0 comments on commit 472121b

Please sign in to comment.