Cetmodules documentation update (develop-1ffbe95)

FNALssi · Oct 14, 2023 · bb4f8ca · bb4f8ca
1 parent e64a075
commit bb4f8ca
Show file tree

Hide file tree

Showing 133 changed files with 1,450 additions and 774 deletions.
diff --git a/git-develop/_sources/manual/cetmodules-commands.7.rst.txt b/git-develop/_sources/manual/cetmodules-commands.7.rst.txt
@@ -3,10 +3,11 @@
 cetmodules-commands(7)
 **********************
 
-Initialization
-==============
+Initialization and Finalization
+===============================
 
 * :command:`cet_cmake_env`
+* :command:`cet_finalize`
 * :command:`cet_set_version_from_file`
 
 Project Variables
@@ -20,6 +21,8 @@ Generation, Installation, and Export
 
 * :command:`basic_plugin`
 * :command:`build_dictionary`
+* :command:`check_class_version`
+* :command:`cet_cmake_config`
 * :command:`cet_cmake_module_directories`
 * :command:`cet_make_alias`
 * :command:`cet_make_library`

diff --git a/git-develop/_sources/manual/cetmodules-variables.7.rst.txt b/git-develop/_sources/manual/cetmodules-variables.7.rst.txt
@@ -7,20 +7,13 @@ cetmodules-variables(7)
 
    .. contents::
 
-Project Variables
-=================
+Variables Affecting Behavior
+============================
 
 .. toctree::
    :maxdepth: 1
    :glob:
 
-   /variable/PROJECT-NAME_*
-
-Variables that Change Behavior
-==============================
-
-.. toctree::
-   :maxdepth: 1
-
    /variable/BUILD_STATIC_LIBS
+   /variable/PROJECT-NAME_*
    /variable/WANT_UPS
diff --git a/git-develop/_sources/variable/PROJECT-NAME_DATA_DIR.rst.txt b/git-develop/_sources/variable/PROJECT-NAME_DATA_DIR.rst.txt
@@ -0,0 +1,6 @@
+<PROJECT-NAME>_DATA_DIR
+-----------------------
+
+Installation data directory.
+
+.. seealso:: :module:`GNUInstallDirs <cmake-ref-current:module:GNUInstallDirs>`
diff --git a/git-develop/_sources/variable/PROJECT-NAME_INCLUDE_DIR.rst.txt b/git-develop/_sources/variable/PROJECT-NAME_INCLUDE_DIR.rst.txt
@@ -1,5 +1,6 @@
 <PROJECT-NAME>_INCLUDE_DIR
----------------------
+--------------------------
 
-   Installation include directory.
+Installation include directory.
 
+.. seealso:: :module:`GNUInstallDirs <cmake-ref-current:module:GNUInstallDirs>`
diff --git a/git-develop/_sources/variable/PROJECT-NAME_LIBRARY_DIR.rst.txt b/git-develop/_sources/variable/PROJECT-NAME_LIBRARY_DIR.rst.txt
@@ -0,0 +1,6 @@
+<PROJECT-NAME>_LIBRARY_DIR
+--------------------------
+
+Installation library directory.
+
+.. seealso:: :module:`GNUInstallDirs <cmake-ref-current:module:GNUInstallDirs>`
diff --git a/git-develop/_sources/variable/PROJECT-NAME_NOARCH.rst.txt b/git-develop/_sources/variable/PROJECT-NAME_NOARCH.rst.txt
@@ -0,0 +1,5 @@
+<PROJECT-NAME>_NOARCH
+---------------------
+
+Indicates whether ``<PROJECT-NAME>`` package is
+architecture-independent.
diff --git a/git-develop/_sources/variable/WANT_UPS.rst.txt b/git-develop/_sources/variable/WANT_UPS.rst.txt
@@ -1,8 +1,10 @@
 WANT_UPS
 --------
 
-Activate the generation of UPS table and version files and Unified
-UPS-compliant installation tarballs. If you don't know what this means
-you almost certainly don't need it. For details of command-line CMake
-variables (``-D...``) and other information, see
-:manual:`cetmodules-compatibility(7)` and :module:`Ups`.
+.. admonitition:: cetbuildtools
+   :class: admonition-legacy
+
+   Activate the generation of UPS table and version files and Unified
+   UPS-compliant installation tarballs. For details of command-line
+   CMake variables (``-D...``) and other information, see
+   :manual:`cetmodules-compatibility(7)` and :module:`Ups`.
diff --git a/git-develop/_static/documentation_options.js b/git-develop/_static/documentation_options.js
@@ -1,5 +1,5 @@
 const DOCUMENTATION_OPTIONS = {
-    VERSION: 'git-develop-7288f75',
+    VERSION: 'git-develop-1ffbe95',
     LANGUAGE: 'en',
     COLLAPSE_INDEX: false,
     BUILDER: 'html',

diff --git a/git-develop/envvar/PATH.html b/git-develop/envvar/PATH.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-  <title>PATH &mdash; Cetmodules git-develop-7288f75 Reference</title>
+  <title>PATH &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
     <link rel="stylesheet" type="text/css" href="../_static/cetmodules.css?v=69c2d5a6" />
@@ -14,7 +14,7 @@
 
     <script src="../_static/jquery.js?v=5d32c60e"></script>
     <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../_static/documentation_options.js?v=c0cb701d"></script>
+    <script src="../_static/documentation_options.js?v=567c09b0"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/bootstrap.bundle.min.js?v=89176c1c"></script>
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 
@@ -146,7 +146,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 

diff --git a/git-develop/genindex.html b/git-develop/genindex.html
diff --git a/git-develop/index.html b/git-develop/index.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-  <title>Reference Documentation &mdash; Cetmodules git-develop-7288f75 Reference</title>
+  <title>Reference Documentation &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
 
     <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=a2c47e09" />
     <link rel="stylesheet" type="text/css" href="_static/cetmodules.css?v=69c2d5a6" />
@@ -14,7 +14,7 @@
 
     <script src="_static/jquery.js?v=5d32c60e"></script>
     <script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="_static/documentation_options.js?v=c0cb701d"></script>
+    <script src="_static/documentation_options.js?v=567c09b0"></script>
     <script src="_static/doctools.js?v=888ff710"></script>
     <script src="_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="_static/bootstrap.bundle.min.js?v=89176c1c"></script>
@@ -51,7 +51,7 @@ <h3>Navigation</h3>
     <a href="./../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="#">Reference</a> &#187;
   </li>
 
@@ -195,7 +195,7 @@ <h3>Navigation</h3>
     <a href="./../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="#">Reference</a> &#187;
   </li>
 

diff --git a/git-develop/manual/buildtool.1.html b/git-develop/manual/buildtool.1.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-  <title>buildtool(1) &mdash; Cetmodules git-develop-7288f75 Reference</title>
+  <title>buildtool(1) &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
     <link rel="stylesheet" type="text/css" href="../_static/cetmodules.css?v=69c2d5a6" />
@@ -14,7 +14,7 @@
 
     <script src="../_static/jquery.js?v=5d32c60e"></script>
     <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../_static/documentation_options.js?v=c0cb701d"></script>
+    <script src="../_static/documentation_options.js?v=567c09b0"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/bootstrap.bundle.min.js?v=89176c1c"></script>
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 
@@ -716,7 +716,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 

diff --git a/git-develop/manual/cet_test_functions.sh.3.html b/git-develop/manual/cet_test_functions.sh.3.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-  <title>cet_test_functions.sh(3) &mdash; Cetmodules git-develop-7288f75 Reference</title>
+  <title>cet_test_functions.sh(3) &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
     <link rel="stylesheet" type="text/css" href="../_static/cetmodules.css?v=69c2d5a6" />
@@ -14,7 +14,7 @@
 
     <script src="../_static/jquery.js?v=5d32c60e"></script>
     <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../_static/documentation_options.js?v=c0cb701d"></script>
+    <script src="../_static/documentation_options.js?v=567c09b0"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/bootstrap.bundle.min.js?v=89176c1c"></script>
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 
@@ -143,7 +143,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 

diff --git a/git-develop/manual/cetmodules-commands.7.html b/git-develop/manual/cetmodules-commands.7.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-  <title>cetmodules-commands(7) &mdash; Cetmodules git-develop-7288f75 Reference</title>
+  <title>cetmodules-commands(7) &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
     <link rel="stylesheet" type="text/css" href="../_static/cetmodules.css?v=69c2d5a6" />
@@ -14,7 +14,7 @@
 
     <script src="../_static/jquery.js?v=5d32c60e"></script>
     <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../_static/documentation_options.js?v=c0cb701d"></script>
+    <script src="../_static/documentation_options.js?v=567c09b0"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/bootstrap.bundle.min.js?v=89176c1c"></script>
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 
@@ -80,10 +80,11 @@ <h3>Navigation</h3>
 
   <span class="target" id="manual:cetmodules-commands(7)"></span><section id="cetmodules-commands-7">
 <h1>cetmodules-commands(7)<a class="headerlink" href="#cetmodules-commands-7" title="Link to this heading">¶</a></h1>
-<section id="initialization">
-<h2>Initialization<a class="headerlink" href="#initialization" title="Link to this heading">¶</a></h2>
+<section id="initialization-and-finalization">
+<h2>Initialization and Finalization<a class="headerlink" href="#initialization-and-finalization" title="Link to this heading">¶</a></h2>
 <ul class="simple">
 <li><p><span class="target" id="index-0-command:cet_cmake_env"></span><a class="reference internal" href="../module/CetCMakeEnv.html#command:cet_cmake_env" title="cet_cmake_env"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cet_cmake_env()</span></code></a></p></li>
+<li><p><span class="target" id="index-0-command:cet_finalize"></span><a class="reference internal" href="../module/CetCMakeConfig.html#command:cet_finalize" title="cet_finalize"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cet_finalize()</span></code></a></p></li>
 <li><p><span class="target" id="index-0-command:cet_set_version_from_file"></span><a class="reference internal" href="../module/CetSetVersionFromFile.html#command:cet_set_version_from_file" title="cet_set_version_from_file"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cet_set_version_from_file()</span></code></a></p></li>
 </ul>
 </section>
@@ -99,6 +100,8 @@ <h2>Generation, Installation, and Export<a class="headerlink" href="#generation-
 <ul class="simple">
 <li><p><span class="target" id="index-0-command:basic_plugin"></span><a class="reference internal" href="../module/BasicPlugin.html#command:basic_plugin" title="basic_plugin"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">basic_plugin()</span></code></a></p></li>
 <li><p><span class="target" id="index-0-command:build_dictionary"></span><a class="reference internal" href="../module/BuildDictionary.html#command:build_dictionary" title="build_dictionary"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">build_dictionary()</span></code></a></p></li>
+<li><p><span class="target" id="index-0-command:check_class_version"></span><a class="reference internal" href="../module/hidden/CheckClassVersion.html#command:check_class_version" title="check_class_version"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">check_class_version()</span></code></a></p></li>
+<li><p><span class="target" id="index-0-command:cet_cmake_config"></span><a class="reference internal" href="../module/CetCMakeConfig.html#command:cet_cmake_config" title="cet_cmake_config"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cet_cmake_config()</span></code></a></p></li>
 <li><p><span class="target" id="index-0-command:cet_cmake_module_directories"></span><a class="reference internal" href="../module/CetCMakeUtils.html#command:cet_cmake_module_directories" title="cet_cmake_module_directories"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cet_cmake_module_directories()</span></code></a></p></li>
 <li><p><span class="target" id="index-0-command:cet_make_alias"></span><a class="reference internal" href="../module/CetCMakeUtils.html#command:cet_make_alias" title="cet_make_alias"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cet_make_alias()</span></code></a></p></li>
 <li><p><span class="target" id="index-0-command:cet_make_library"></span><a class="reference internal" href="../module/CetMakeLibrary.html#command:cet_make_library" title="cet_make_library"><code class="xref cmake cmake-command docutils literal notranslate"><span class="pre">cet_make_library()</span></code></a></p></li>
@@ -137,7 +140,7 @@ <h2>Deprecated<a class="headerlink" href="#deprecated" title="Link to this headi
     <h3><a href="../index.html">Table of Contents</a></h3>
     <ul>
 <li><a class="reference internal" href="#">cetmodules-commands(7)</a><ul>
-<li><a class="reference internal" href="#initialization">Initialization</a></li>
+<li><a class="reference internal" href="#initialization-and-finalization">Initialization and Finalization</a></li>
 <li><a class="reference internal" href="#project-variables">Project Variables</a></li>
 <li><a class="reference internal" href="#generation-installation-and-export">Generation, Installation, and Export</a></li>
 <li><a class="reference internal" href="#utility">Utility</a></li>
@@ -202,7 +205,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 

diff --git a/git-develop/manual/cetmodules-compatibility.7.html b/git-develop/manual/cetmodules-compatibility.7.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-  <title>cetmodules-compatibility(7) &mdash; Cetmodules git-develop-7288f75 Reference</title>
+  <title>cetmodules-compatibility(7) &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
     <link rel="stylesheet" type="text/css" href="../_static/cetmodules.css?v=69c2d5a6" />
@@ -14,7 +14,7 @@
 
     <script src="../_static/jquery.js?v=5d32c60e"></script>
     <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../_static/documentation_options.js?v=c0cb701d"></script>
+    <script src="../_static/documentation_options.js?v=567c09b0"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/bootstrap.bundle.min.js?v=89176c1c"></script>
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 
@@ -143,7 +143,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 

diff --git a/git-develop/manual/cetmodules-concepts.7.html b/git-develop/manual/cetmodules-concepts.7.html
@@ -5,7 +5,7 @@
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.18.1: http://docutils.sourceforge.net/" />
 
-  <title>cetmodules-concepts(7) &mdash; Cetmodules git-develop-7288f75 Reference</title>
+  <title>cetmodules-concepts(7) &mdash; Cetmodules git-develop-1ffbe95 Reference</title>
 
     <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a2c47e09" />
     <link rel="stylesheet" type="text/css" href="../_static/cetmodules.css?v=69c2d5a6" />
@@ -14,7 +14,7 @@
 
     <script src="../_static/jquery.js?v=5d32c60e"></script>
     <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
-    <script src="../_static/documentation_options.js?v=c0cb701d"></script>
+    <script src="../_static/documentation_options.js?v=567c09b0"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/bootstrap.bundle.min.js?v=89176c1c"></script>
@@ -55,7 +55,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>
 
@@ -143,7 +143,7 @@ <h3>Navigation</h3>
     <a href="../../">Cetmodules Documentation</a> &#187;
   </li>
   <li>
-    <span class="version_switch">git-develop-7288f75</span>
+    <span class="version_switch">git-develop-1ffbe95</span>
     <a href="../index.html">Reference</a> &#187;
   </li>