build system: Support staged installs via DESTDIR

[paulmenzel]

Currenty, the variable INSTALL seems to be used as prefix, which for CMake is CMAKE_INSTALL_PREFIX.

SuiteSparse/SuiteSparse_config/SuiteSparse_config.mk

Lines 60 to 86 in 257b2ba

	# For "make install" and "make uninstall", the default location is
	# SuiteSparse/lib, SuiteSparse/include, and
	# SuiteSparse/share/doc/suitesparse-x.y.z
	# If you do this:
	# make install INSTALL=/usr/local
	# then the libraries are installed in /usr/local/lib, include files in
	# /usr/local/include, and documentation in
	# /usr/local/share/doc/suitesparse-x.y.z.
	# You can instead specify the install location of each of these 3 components
	# separately, via (for example):
	# make install INSTALL_LIB=/yada/mylibs INSTALL_INCLUDE=/yoda/myinc \
	# INSTALL_DOC=/solo/mydox
	# which puts the libraries in /yada/mylibs, include files in /yoda/myinc,
	# and documentation in /solo/mydox.
	INSTALL ?= $(SUITESPARSE)
	INSTALL_LIB ?= $(INSTALL)/lib
	INSTALL_INCLUDE ?= $(INSTALL)/include
	INSTALL_DOC ?= $(INSTALL)/share/doc/suitesparse-$(SUITESPARSE_VERSION)
	#---------------------------------------------------------------------------
	# parallel make
	#---------------------------------------------------------------------------
	# use 8 jobs by default
	JOBS ?= 8
	CMAKE_OPTIONS ?= -DCMAKE_INSTALL_PREFIX=$(INSTALL)

Packagers often require support for staged installs. From CMake documentation:

On UNIX one can use the DESTDIR mechanism in order to relocate the whole installation. See DESTDIR for more information.

It’d be great, if the install target could be extended to support the variable DESTDIR.

[DrTimothyAldenDavis]

Yes, this is something I plan on doing, as part of my migration to cmake.

…

On Thu, Apr 8, 2021 at 8:44 AM Paul Menzel ***@***.***> wrote: Assigned #86 <#86> to @DrTimothyAldenDavis <https://github.com/DrTimothyAldenDavis>. — You are receiving this because you were assigned. Reply to this email directly, view it on GitHub <#86 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AEYIIOOEAS7F4CKUTA2IDGTTHWXKXANCNFSM42S5T6GQ> .

[kiwifb]

I just tested a staged install straight from the tarball with

make global CMAKE_INSTALL_PREFIX=/usr
make install CMAKE_INSTALL_PREFIX=/usr DESTDIR=${somewhere_in_my_home}

and it worked like a charm. I'd say that is pretty much fixed in 6.0.1.

[kiwifb]

Actually scratch that, I didn't notice but it didn't use /usr but /usr/local. I probably did not read the instruction properly. Checking.

[kiwifb]

It should be

make global CMAKE_OPTIONS="-DCMAKE_INSTALL_PREFIX=/usr"

[DrTimothyAldenDavis]

Thanks for the update. I'll close this issue then.

[paulmenzel]

Probably it was fixed by the update from 5.13.0 to 6.0.0 in commit ad1b089 (to SuiteSparse v6.0.0), where SuiteSparse_config/SuiteSparse_config.mk was removed, and the change-log says:

SuiteSparse/ChangeLog

Line 3 in d42beeb

* major update: using CMake build system for all packages

[DrTimothyAldenDavis]

Yes -- the new cmake build system should be doing the right thing for staged installs.

I also have a non-default "local install" option that installs into SuiteSparse/lib, SuiteSparse/include, and SuiteSparse/bin, as a built-in type of staged install. See:

SuiteSparse/SuiteSparse_config/cmake_modules/SuiteSparsePolicy.cmake

Line 26 in 4faaddd

# LOCAL_INSTALL: if true, "make install" will

The default "global install" installs into the CMAKE_INSTALL_PREFIX. Changing that will change where "make install" will install the compiled libraries and include.h files.

[DrTimothyAldenDavis]

DESTDIR should also work, since this environment variable modifies CMAKE_INSTALL_PREFIX (but I haven't tried it):

https://cmake.org/cmake/help/latest/envvar/DESTDIR.html#envvar:DESTDIR

[kiwifb]

I tested DESTDIR and it behaved as expected for me.