Skip to content

Home

Jump to bottom
Luau edited this page May 4, 2024 · 14 revisions

Documentation

Welcome to the minpack-builder wiki! Here, you can find all the possible configuration options supported by minpack-builder, and detailed build-and-install instructions for minpack on different combinations of platform / Fortran compiler toolchain. Moreover, we provide documentation to use minpack as a CMake package after you installed it through minpack-builder.

Table of Contents

Configuration Options

Tip

Each parameter below can be set by adding "-D<PARAMETER>=<VALUE>" in the command line.

For instance, cmake "-DCMAKE_BUILD_TYPE=Debug" <PARAMETER LIST> would configure a debug build.

CMAKE_BUILD_TYPE

  • Parameter: CMAKE_BUILD_TYPE
  • Type: STRING
  • Default value: Release
  • Description: The build type.
  • Note: Common values are Debug, Release, RelWithDebInfo and MinSizeRel.

BUILD_SHARED_LIBS

  • Parameter: BUILD_SHARED_LIBS
  • Type: BOOL
  • Default value: ON
  • Description: Builds the shared library.
  • Note: If this value is OFF, then BUILD_STATIC_LIBS must be set ON.

BUILD_STATIC_LIBS

  • Parameter: BUILD_STATIC_LIBS
  • Type: BOOL
  • Default value: ON
  • Description: Builds the static library.
  • Note: If this value is OFF, then BUILD_SHARED_LIBS must be set ON.

MINPACK_VERSION

  • Parameter: MINPACK_VERSION
  • Type: STRING
  • Default value: 1.1.0
  • Description: The version of this build script.
  • Note: Since it is unlikely to face any change in the source code of minpack, this value makes sense to be interpreted as this build script's version.

USE_DOWNLOAD

  • Parameter: USE_DOWNLOAD
  • Type: BOOL
  • Default value: ON
  • Description: Allows official files to be downloaded from https://www.netlib.org/minpack to do the build.
  • Note: If this option is left OFF, ${CMAKE_CURRENT_SOURCE_DIR} is assumed to be the location of minpack source files and copyright.

DOWNLOAD_DIR

  • Parameter: DOWNLOAD_DIR
  • Type: PATH
  • Default value: ${CMAKE_CURRENT_SOURCE_DIR}
  • Description: Destination directory to store files downloaded from https://www.netlib.org/minpack.
  • Note: This value only makes sense if USE_DOWNLOAD is set ON.

MINPACK_INSTALL_BINDIR

  • Parameter: MINPACK_INSTALL_BINDIR
  • Type: PATH
  • Default value: ${CMAKE_INSTALL_BINDIR}
  • Description: Installation directory for executables (.dll files on Windows).
  • Note: This value must be a relative path to ${CMAKE_INSTALL_PREFIX}.

MINPACK_INSTALL_LIBDIR

  • Parameter: MINPACK_INSTALL_LIBDIR
  • Type: PATH
  • Default value: ${CMAKE_INSTALL_LIBDIR}
  • Description: Installation directory for libraries.
  • Note: This value must be a relative path to ${CMAKE_INSTALL_PREFIX}.

MINPACK_INSTALL_INCLUDEDIR

  • Parameter: MINPACK_INSTALL_INCLUDEDIR
  • Type: PATH
  • Default value: ${CMAKE_INSTALL_INCLUDEDIR}
  • Description: Installation directory for header files.
  • Note: This value must be a relative path to ${CMAKE_INSTALL_PREFIX}.

MINPACK_INSTALL_DOCDIR

  • Parameter: MINPACK_INSTALL_DOCDIR
  • Type: PATH
  • Default value: ${CMAKE_INSTALL_DOCDIR}
  • Description: Installation directory for documentation.
  • Note: This value must be a relative path to ${CMAKE_INSTALL_PREFIX}.

MINPACK_INSTALL_PKGCONFIGDIR

  • Parameter: MINPACK_INSTALL_PKGCONFIGDIR
  • Type: PATH
  • Default value: ${MINPACK_INSTALL_LIBDIR}/pkgconfig
  • Description: Installation directory for pkg-config (.pc) files.
  • Note: This value must be a relative path to ${CMAKE_INSTALL_PREFIX}.

Build and Install Usage

Important

At the moment, the documentation for usage is in early stages.

The build-and-install usage is split by platform and Fortran compiler. For now, you can check the usage on Linux, building minpack with GFortran.

CMake Package

After you have built and installed minpack through minpack-builder, you can use minpack as a CMake Package. For detailed instructions, have a read at CMake Package.

Clone this wiki locally