Debian Codegraph @

cmake/tribits/doc/guides/TribitsPackageNotCMakePackage.rst

raw
1 Why a TriBITS Package is not a CMake Package
2 --------------------------------------------
3
4 Note that a `TriBITS Package`_ is not the same thing as a "Package" in raw
5 CMake terminology. In raw CMake, a "Package" is some externally provided bit
6 of software or other utility for which the current CMake project has an
7 optional or required dependency (see `CMake: How to Find Libraries
8 <http://www.cmake.org/Wiki/CMake:How_To_Find_Libraries>`_). Therefore, a raw
9 CMake "Package" actually maps to a `TriBITS TPL`_. A raw CMake "Package"
10 (e.g. Boost, CUDA, etc.) can be found using a standard CMake find module
11 ``Find<rawPackageName>.cmake`` using the built-in CMake command
12 ``find_package(<rawPackageName>)``. It is unfortunate that the TriBITS and
13 the raw CMake definitions of the term "Package" are not exactly the same.
14 However, the term "Package" was coined by the Trilinos project long ago before
15 CMake was adopted as the Trilinos build system and Trilinos' definition of
16 "Package" (going back to 1998) pre-dates the development of CMake (see
17 `History of CMake <http://en.wikipedia.org/wiki/CMake#History>`_) and
18 therefore Trilinos dictated the terminology of TriBITS and the definition of
19 the term "Package" in the TriBITS system. However, note that both meanings of
20 the term "Package" are consistent with the more general software engineering
21 definition of a "Package" according to `Software Engineering Packaging
22 Principles`_.