kolan
/
CMake
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

ExternalData: Document all variables defined by module 

Extend the "Module Variables" section to list variables
previously mentioned only in text.
This commit is contained in:
Brad King 2015-01-12 14:58:17 -05:00
parent f3884b47ec
commit 531e75e0b7
1 changed files with 21 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
Modules/ExternalData.cmake
View File

@ -68,11 +68,11 @@ Module Functions
It creates custom commands in the target as necessary to make data It creates custom commands in the target as necessary to make data
files available for each ``DATA{}`` reference previously evaluated by files available for each ``DATA{}`` reference previously evaluated by
other functions provided by this module. A list of URL templates may other functions provided by this module.
be provided in the variable ``ExternalData_URL_TEMPLATES`` using the Data files may be fetched from one of the URL templates specified in
placeholders ``%(algo)`` and ``%(hash)`` in each template. Data fetch the ``ExternalData_URL_TEMPLATES`` variable, or may be found locally
rules try each URL template in order by substituting the hash in one of the paths specified in the ``ExternalData_OBJECT_STORES``
algorithm name for ``%(algo)`` and the hash value for ``%(hash)``. variable.
Hash Algorithms Hash Algorithms
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
@ -177,6 +177,14 @@ Module Variables
The following variables configure behavior. They should be set before The following variables configure behavior. They should be set before
calling any of the functions provided by this module. calling any of the functions provided by this module.
.. variable:: ExternalData_URL_TEMPLATES
The ``ExternalData_URL_TEMPLATES`` may be set to provide a list of
of URL templates using the placeholders ``%(algo)`` and ``%(hash)``
in each template. Data fetch rules try each URL template in order
by substituting the hash algorithm name for ``%(algo)`` and the hash
value for ``%(hash)``.
.. variable:: ExternalData_LINK_CONTENT .. variable:: ExternalData_LINK_CONTENT
The ``ExternalData_LINK_CONTENT`` variable may be set to the name of a The ``ExternalData_LINK_CONTENT`` variable may be set to the name of a
@ -225,6 +233,14 @@ calling any of the functions provided by this module.
The ``ExternalData_TIMEOUT_ABSOLUTE`` variable sets the download The ``ExternalData_TIMEOUT_ABSOLUTE`` variable sets the download
absolute timeout, in seconds, with a default of ``300`` seconds. absolute timeout, in seconds, with a default of ``300`` seconds.
Set to ``0`` to disable enforcement. Set to ``0`` to disable enforcement.
.. variable:: ExternalData_SERIES_PARSE
ExternalData_SERIES_PARSE_PREFIX
ExternalData_SERIES_PARSE_NUMBER
ExternalData_SERIES_PARSE_SUFFIX
ExternalData_SERIES_MATCH
See `Referencing File Series`_.
#]=======================================================================] #]=======================================================================]
#============================================================================= #=============================================================================