CMake-lib storage component

Linux: , Windows: , Mac OS:

• CMake-lib storage component
  • Usage
  • General
    • Remote GIT repository structure
    • CMLibStorage.cmake structure
    • Variable templates
  • Bug reports and feature requests

It is a mechanism for storing and retreiving build dependencies like CMake modules, build scrips, build resources etc.

CMake-lib storage read dependencies from CMLibStorage.cmake file stored in CMAKE_CURRENT_SOURCE_DIR.

Each dependency is downloaded and the STORAGE.cmake in the remote git repository is called.

Usage

CMUTIL is intended to be used thru CMLIB.

CMUTIL is not supposed to be used separately.

To use the component install CMLIB and call FIND_PACKAGE(CMLIB COMPONENTS CMUTIL).

General

CMake-lib storage tracks and maintains remote git repositories in a simple way.

The component is intended for two main use-cases:

• to store all URIs in one place. The repository is created and in the STORAGE.cmake all remote URIs which the project needs are stored
• when CMake macros/modules, build scripts/resources etc are common for all components of a project. A git repository is created and all shared dependencies are uploaded into it.

Remote GIT repository structure

Terminology:

• CMake-lib storage refers to this library and repository.
• CMake-lib shared storage refers to remote git repositories which are maintained by this library.
• CMake-lib shared storage is a "standard" - each repository which meet requirements noted in this section can be considered as CMake-lib shared storage.

CMake-lib shared storage requirements:

Shared storage is represented by Git repository. Let the GIT_ROOT is git root of the storage repository.
In the GIT_ROOT there must be file called STORAGE.cmake which is included by cmake INCLUDE command once the repository is downloaded.

CMLibStorage.cmake structure

CMLibStorage.cmake required variables

• STORAGE_LIST - nonempty, finite set of shared storage names,
• STORAGE_LIST_<name> - URI which represents shared storage 'name' - name must be from STORAGE_LIST
• STORAGE_LIST_<name>_REVISION - which represents shared storage 'name' - name must be from STORAGE_LIST

Look at example at example/CMLibStorage.cmake

Variable templates

The Storage implements a mechanism called "Variable template".

Consider a scenario with a URI for Boost. An application needs to be written for Windows, Mac and Linux.
Let "https://mystorage.com/boost_107400_windows_amd64.zip" be a URI for Boost 1.74.0 for 64-bit windows.

The variable is defined in the form SET(BOOST_URI_TEMPLATE "https://mystorage.com/boost_<version>_<OS>_<PlAtFoRm>.zip")

To obtain the URL for Boost 1.74.0 for 64-bit windows using the template variable BOOST_URI_TEMPLATE, the following call is made:

SET(BOOST_URI_TEMPLATE "https://mystorage.com/boost_<version>_<OS>_<PlAtFoRm>.zip")
CMLIB_STORAGE_TEMPLATE_INSTANCE(
  boost_uri
  BOOST_URI_TEMPLATE
  version  107400
  os       windows
  platform amd64
)
MESSAGE(STATUS "Boost URI: ${boost_uri}")

It prints "https://mystorage.com/boost_107400_windows_amd64.zip".

Bug reports and feature requests

Bug reports and feature requests can be submitted by creating a Github Issue.

Questions should be posted using Github Discussion