Meta-ticket: Update other packages to using the sage-dist-helpers functions + DESTDIR where applicable

embray commented 7 years ago

This is a meta-ticket for tickets that address updating other packages to use the helper functions in sage-dist-helpers where possible. There are a few advantages to doing this:

In general it simplifies these scripts and reduces a lot of boilerplate. As more functions get written even more boilerplate can be removed, but even the existing functions help a lot.
Although this requires irritating bulk updates to packages now, it reduces the overall need for such bulk updates in the future, since many packages that have similar build and installation steps can be be updated at once by updates to the applicable helper functions.

The second bullet point is especially motivated right now by #22509. Since it requires updates to nearly every package in Sage anyways, it makes more sense to update most packages to use the helper functions, and then add DESTDIR support through the helper functions. In particular, the vast majority of Python and autotools packages can be given DESTDIR support en masse by this approach.

24014 and #24018 -- Update Python packages that are installed with pip to use sdh_pip_install
24025 -- Update "trivial" autotools packages to use sdh_configure, sdh_make, and sdh_install. By "trivial" I mean packages with very simple build scripts that can be mechanically updated with simple replacements.
25038 Update some standard packages that were excluded from #24025 due to conflicts with other existing tickets
- curl
- gc
Miscellaneous packages that have already been converted (e.g. as part of a version update):
- ~~#24692 - gdb (optional)~~
- ~~#26021 - tides (optional)~~
27039 Update some optional packages that use autotools in a standard way but were just excluded from #24025 due to not being standard packages
- 4ti2
- bliss
- cbc
- csdp
- deformation
- fricas
- gp2c
- igraph
- latte_int
- libogg
- lidia
- lrslib
- mpfrcx
- sirocco
- tdlib
????? Same as previous, but for experimental packages:
- libtheora - doesn't even build successfully for me ATM
- surf - doesn't even build successfully for me ATM
- valgrind
Update "trickier" autotools packages that take a little extra care for some reason:
- 25043 - python2/python3
- ????? - compilerwrapper (experimental)
- ????? - gambit (optional)
- 22626 - gap
- 26856 - gap_packages (optional)
- 27016 - gcc (optional)
- ????? - git (optional)
- ~~#25001 #27016 - gfortran (optional)~~
- ????? - gmp (optional)
- 25045 - mpfr
- 25086 - nauty
- 25087 - ppl
- 25049 - r
- ????? - termcap (has a configure from a very old autoconf)
- ????? - topcom (its existing spkg-install uses install-strip instead of install and one can see why: the debugging info for this library is quite large for some reason; need an alternative to sdh_make_install that allows alternate install targets)
Handle miscellaneous non-autotools packages. There are some like this that may still be applicable (e.g. they don't use configure but they still use make in such a way that can be replaced with sdh_make). It might also be possible to narrow down one or two other classes of packages that can be simplified with new helper functions.
- 25035 - arb - has a hand-written configure script
- ????? - cmake (optional)
- 29150 - coxeter3 (optional)
- 25035 - flint- has a hand-written configure script
- 25042 - freetype - has a hand-written configure script
- ????? - gap3 (experimental) - do we care?
- 25100 - gfan
- 25100 - lcalc
- ????? - lie (experimental)
- 29148 - mcqd (optional)
- ????? - modular_decomposition (experimental)
- 27511 - normaliz (optional)
- 25037 - ntl - has a hand-written configure script
- 25052 - openblas
- ????? - openssl
- 25144 - palp
- 25143 - pari
- ????? - perl_term_readline_gnu (experimental)
- 27398 - plantri (optional)
- ????? - polymake (experimental)
- ????? - qepcad (experimental)
- 25100 - ratpoints
- 25100 - rubiks
- ????? - saclib (optional)
- ????? - scipoptsuite (experimental)
- ????? - sip (optional)
- 25100 - symmetrica
- 25099 - sympow
- 25048 - tachyon
- 25142 - zlib - has a hand-written configure script
- 25085 - zn_poly - configure is just a wrapper for a custom Python script called makemakefile.py
Some Python packages for which a simple pip install does not suffice:
- 25092 - cysignals
- 25051 - numpy
- 25051 - pillow
- 25051 - pip
- ????? - scons (optional)
- 25051 - setuptools
Handle packages that don't have any kind of "build system" and just involve copying files. It might still be nice to have a helper function for this, for example, that ensures that all the destination directories are created under $SAGE_DESTDIR_LOCAL.
- 25147 - boost_cropped
- 25040 - combinatorial_designs
- 25040 - graphs
- ????? - jmol
- 25039 - mathjax
- 25040 - pari_galdata
- 25040 - pari_seadata_small
- 25040 - polytopes_db
- 25039 - thebe
- 25040 - threejs
Miscellaneous packages with Python-based installers:
- ????? - atlas (optional)
- ????? - conway_polynomials
- ????? - elliptic_curves

Component: build

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

jdemeyer commented 7 years ago

Description changed:

--- 
+++ 
@@ -6,7 +6,7 @@

 The second bullet point is especially motivated right now by #22509.  Since it requires updates to nearly every package in Sage anyways, it makes more sense to update most packages to use the helper functions, and then add `DESTDIR` support through the helper functions.  In particular, the vast majority of Python and autotools packages can be given `DESTDIR` support en masse by this approach.

-* #24014 -- Update Python packages that are installed with `pip` to use `sdh_pip_install`
-* #????? -- Update "trival" autotools packages to use `sdh_configure`, `sdh_make`, and `sdh_install`.  By "trivial" I mean packages with very simple build scripts that can be mechanically updated with simple replacements.
+* #24014 and #24018 -- Update Python packages that are installed with `pip` to use `sdh_pip_install`
+* #????? -- Update "trivial" autotools packages to use `sdh_configure`, `sdh_make`, and `sdh_install`.  By "trivial" I mean packages with very simple build scripts that can be mechanically updated with simple replacements.
 * #????? -- Update "trickier" autotools packages that take a little extra care for some reason.  I'm not even sure if there are any like this yet.
 * #????? -- Handle miscellaneous non-autotools packages.  There are some like this that may still be applicable (e.g. they don't use `configure` but they still use `make` in such a way that can be replaced with `sdh_make`).  It might also be possible to narrow down one or two other classes of packages that can be simplified with new helper functions.

embray commented 7 years ago

Description changed:

--- 
+++ 
@@ -7,6 +7,6 @@
 The second bullet point is especially motivated right now by #22509.  Since it requires updates to nearly every package in Sage anyways, it makes more sense to update most packages to use the helper functions, and then add `DESTDIR` support through the helper functions.  In particular, the vast majority of Python and autotools packages can be given `DESTDIR` support en masse by this approach.

 * #24014 and #24018 -- Update Python packages that are installed with `pip` to use `sdh_pip_install`
-* #????? -- Update "trivial" autotools packages to use `sdh_configure`, `sdh_make`, and `sdh_install`.  By "trivial" I mean packages with very simple build scripts that can be mechanically updated with simple replacements.
+* #24025 -- Update "trivial" autotools packages to use `sdh_configure`, `sdh_make`, and `sdh_install`.  By "trivial" I mean packages with very simple build scripts that can be mechanically updated with simple replacements.
 * #????? -- Update "trickier" autotools packages that take a little extra care for some reason.  I'm not even sure if there are any like this yet.
 * #????? -- Handle miscellaneous non-autotools packages.  There are some like this that may still be applicable (e.g. they don't use `configure` but they still use `make` in such a way that can be replaced with `sdh_make`).  It might also be possible to narrow down one or two other classes of packages that can be simplified with new helper functions.

embray commented 7 years ago

comment:4

Note that for #22509 there will have be a second round of updates to DESTDIR support for some packages that manually copy files to locations in $SAGE_LOCAL. However, making these updates first still significantly reduces that number of packages that will require additional treatment.