This commit is contained in:
GitHub Actions
+5
-5
@@ -85,8 +85,7 @@ version(<a class="reference internal" href="#generate">GENERATE</a> <out-var&
|
||||
version(<a class="reference internal" href="#modify">MODIFY</a> <out-var> <string> [COMPRESS] [MAJOR <major>] [MINOR <minor] [PATCH <patch>] [TWEAK <tweak>] [PRERELEASE <prerelease>] [BUILD <build>])
|
||||
version(<a class="reference internal" href="#compare">COMPARE</a> <out-var> <a> <b>)</pre>
|
||||
<p>The following version constructs are currently supported:</p>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">major</span><span class="o">></span> <span class="s2">"."</span> <span class="o"><</span><span class="n">minor</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">patch</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">tweak</span><span class="o">></span><span class="p">]]</span>
|
||||
<span class="o"><</span><span class="n">major</span><span class="o">></span> <span class="s2">"."</span> <span class="o"><</span><span class="n">minor</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">patch</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">tweak</span><span class="o">></span><span class="p">]]</span> <span class="p">[[</span><span class="s2">"-"</span><span class="p">]</span> <span class="o"><</span><span class="n">pre</span><span class="o">-</span><span class="n">release</span><span class="o">></span><span class="p">]</span> <span class="p">[</span><span class="s2">"+"</span> <span class="o"><</span><span class="n">build</span><span class="o">></span><span class="p">]</span>
|
||||
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="o"><</span><span class="n">major</span><span class="o">></span> <span class="s2">"."</span> <span class="o"><</span><span class="n">minor</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">patch</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">tweak</span><span class="o">></span><span class="p">]]</span> <span class="p">[[</span><span class="s2">"-"</span><span class="p">]</span> <span class="o"><</span><span class="n">pre</span><span class="o">-</span><span class="n">release</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">pre</span><span class="o">-</span><span class="n">release</span><span class="o">></span> <span class="p">[</span><span class="o">...</span><span class="p">]]]</span> <span class="p">[</span><span class="s2">"+"</span> <span class="o"><</span><span class="n">build</span><span class="o">></span> <span class="p">[</span><span class="s2">"."</span> <span class="o"><</span><span class="n">build</span><span class="o">></span> <span class="p">[</span><span class="o">...</span><span class="p">]]]</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
</section>
|
||||
@@ -95,14 +94,14 @@ version(<a class="reference internal" href="#compare">COMPARE</a> <out-var>
|
||||
<div class="highlight-cmake notranslate" id="parse"><div class="highlight"><pre><span></span><span class="nb">version</span><span class="p">(</span><span class="s">PARSE</span><span class="w"> </span><span class="s"><out-var></span><span class="w"> </span><span class="s"><string></span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Attempts to parse the version in <code class="docutils literal notranslate"><span class="pre"><string></span></code> and stores the individual compoents into <code class="docutils literal notranslate"><span class="pre"><out-var>_<component></span></code>. If a component is not present in the given version, it will be undefined. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will be defined and contain the error message.</p>
|
||||
<p>Attempts to parse the version in <code class="docutils literal notranslate"><span class="pre"><string></span></code> and stores the individual compoents into <code class="docutils literal notranslate"><span class="pre"><out-var>_<component></span></code>. If a component is not present in the given version, it will be undefined. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will be defined and contain the error message. The <code class="docutils literal notranslate"><span class="pre">PRERELEASE</span></code> and <code class="docutils literal notranslate"><span class="pre">BUILD</span></code> components support the dot-separation specifier and will be turned into a list if they are encountered.</p>
|
||||
</section>
|
||||
<section id="generating">
|
||||
<h2>Generating<a class="headerlink" href="#generating" title="Permalink to this heading"></a></h2>
|
||||
<div class="highlight-cmake notranslate" id="generate"><div class="highlight"><pre><span></span><span class="nb">version</span><span class="p">(</span><span class="s">GENERATE</span><span class="w"> </span><span class="s"><out-var></span><span class="w"> </span><span class="s">[COMPRESS]</span><span class="w"> </span><span class="s">[MAJOR</span><span class="w"> </span><span class="s"><major>]</span><span class="w"> </span><span class="s">[MINOR</span><span class="w"> </span><span class="s"><minor>]</span><span class="w"> </span><span class="s">[PATCH</span><span class="w"> </span><span class="s"><patch>]</span><span class="w"> </span><span class="s">[TWEAK</span><span class="w"> </span><span class="s"><tweak>]</span><span class="w"> </span><span class="s">[PRERELEASE</span><span class="w"> </span><span class="s"><prerelease>]</span><span class="w"> </span><span class="s">[BUILD</span><span class="w"> </span><span class="s"><build>]</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Generates a version from the components provided and stores the result in <code class="docutils literal notranslate"><span class="pre"><out-var></span></code>. The components <code class="docutils literal notranslate"><span class="pre"><major></span></code> and <code class="docutils literal notranslate"><span class="pre"><minor></span></code> will default to <code class="docutils literal notranslate"><span class="pre">0</span></code> if not provided. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will be defined and contain the error message.</p>
|
||||
<p>Generates a version from the components provided and stores the result in <code class="docutils literal notranslate"><span class="pre"><out-var></span></code>. The components <code class="docutils literal notranslate"><span class="pre"><major></span></code> and <code class="docutils literal notranslate"><span class="pre"><minor></span></code> will default to <code class="docutils literal notranslate"><span class="pre">0</span></code> if not provided. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will be defined and contain the error message. The <code class="docutils literal notranslate"><span class="pre">PRERELEASE</span></code> and <code class="docutils literal notranslate"><span class="pre">BUILD</span></code> components support the dot-separation specifier and will be converted from a list if encountered.</p>
|
||||
</section>
|
||||
<section id="modifying">
|
||||
<h2>Modifying<a class="headerlink" href="#modifying" title="Permalink to this heading"></a></h2>
|
||||
@@ -123,9 +122,10 @@ version(<a class="reference internal" href="#compare">COMPARE</a> <out-var>
|
||||
<li><p>If a component is numerical and the value is larger in <code class="docutils literal notranslate"><span class="pre"><a></span></code>, <code class="docutils literal notranslate"><span class="pre"><out-var></span></code> will contain the componenent name prefixed by <code class="docutils literal notranslate"><span class="pre">></span></code>.</p></li>
|
||||
<li><p>If a component is numerical and the value is larger in <code class="docutils literal notranslate"><span class="pre"><b></span></code>, <code class="docutils literal notranslate"><span class="pre"><out-var></span></code> will contain the componenent name prefixed by <code class="docutils literal notranslate"><span class="pre"><</span></code>.</p></li>
|
||||
<li><p>If a component is alphanumerical and the value is different in either, <code class="docutils literal notranslate"><span class="pre"><out-var></span></code> will contain the component name with no prefix.</p></li>
|
||||
<li><p>In all other cases, <code class="docutils literal notranslate"><span class="pre"><out-var></span></code> will be empty.</p></li>
|
||||
<li><p>If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will be defined and contain the error message, and <code class="docutils literal notranslate"><span class="pre"><out-var></span></code> will be undefined.</p></li>
|
||||
<li><p>In all other cases, <code class="docutils literal notranslate"><span class="pre"><out-var></span></code> will be empty.</p></li>
|
||||
</ul>
|
||||
<p>There is no special handling for dot-separated <code class="docutils literal notranslate"><span class="pre">PRERELEASE</span></code> and <code class="docutils literal notranslate"><span class="pre">BUILD</span></code> component. They will be treated as if they were a string, as special handling for these is up to the application.</p>
|
||||
</section>
|
||||
</section>
|
||||
|
||||
|
||||
Reference in New Issue
Block a user