what-is-it.rst

What is it?

Every Hunter release (Atom feed) archive is a meta-package with build instructions and URLs of real packages. The archive will be downloaded and unpacked automatically by the HunterGate CMake module. You only need to set the URL and SHA1:

HunterGate(
    URL "https://github.com/ruslo/hunter/archive/v0.14.5.tar.gz"
    SHA1 "f2c3de6d13baf8c5d2aa77bdc47c516e668c677e"
)

Here is the content of the archive in simplified form:

Hunter (0.14.15) = {
    Boost (1.60.0, 1.59.0, 1.58.0-p1, ...),
    GTest (1.7.0, ...),
    OpenCV (3.0.0-beta, 2.4.11, 2.4.10, ...),
    OpenSSL (1.0.2g, 1.0.2f, 1.0.2e, ...),
    ...
}

If you download and unpack it, you can view some internals. Let's look at the OpenSSL package properties:

.. literalinclude:: what-is-it.sh
  :language: shell
  :start-after: # doc: download-start
  :end-before: # doc: download-end

hunter.cmake holds the list of available versions:

.. literalinclude:: what-is-it.sh
  :language: shell
  :start-after: # doc: version-start
  :end-before: # doc: version-end

    VERSION
    "1.0.2g"
    URL
    "https://github.com/openssl/openssl/archive/OpenSSL_1_0_2g.tar.gz"
--
    VERSION
    "1.0.2f"
    URL
    "https://github.com/openssl/openssl/archive/OpenSSL_1_0_2f.tar.gz"
--
    VERSION
    "1.0.2e"
    URL
    "https://github.com/openssl/openssl/archive/OpenSSL_1_0_2e.tar.gz"

Install instructions from build scheme url_sha1_openssl.cmake.in:

.. literalinclude:: what-is-it.sh
  :language: shell
  :start-after: # doc: install-start
  :end-before: # doc: install-end

INSTALL_COMMAND
make install_sw

Default version from default.cmake (is customizable, see :ref:`Config-ID <config-id>`):

.. literalinclude:: what-is-it.sh
  :language: shell
  :start-after: # doc: default-start
  :end-before: # doc: default-stop

hunter_default_version(OpenSSL VERSION 1.0.2g)

.. seealso::

  * :doc:`Detailed sources layout </reference/layouts/sources>`
  * :doc:`Creating version on the fly from Git submodule </user-guides/hunter-user/git-submodule>`