This commit is contained in:
GitHub Actions
+8
-8
@@ -4,7 +4,7 @@
|
||||
<meta charset="utf-8" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" />
|
||||
|
||||
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
||||
<title>version — version 1.2.2 documentation</title>
|
||||
<title>version — version 1.3.0 documentation</title>
|
||||
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
||||
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
|
||||
<!--[if lt IE 9]>
|
||||
@@ -29,7 +29,7 @@
|
||||
<a href="#" class="icon icon-home"> version
|
||||
</a>
|
||||
<div class="version">
|
||||
1.2.2
|
||||
1.3.0
|
||||
</div>
|
||||
<div role="search">
|
||||
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
|
||||
@@ -80,9 +80,9 @@
|
||||
<p>Generate, parse and modify versions purely with CMake. Supports Semantic Versioning 2.0.0, 1.0.0 and other version formats.</p>
|
||||
<section id="synopsis">
|
||||
<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this heading"></a></h2>
|
||||
<pre class="literal-block">version(<a class="reference internal" href="#parse">PARSE</a> <out-var> <string>)
|
||||
<pre class="literal-block">version(<a class="reference internal" href="#parse">PARSE</a> <out-var> [REQUIRE [PATCH|TWEAK][;...]] <string>)
|
||||
version(<a class="reference internal" href="#generate">GENERATE</a> <out-var> [COMPRESS] [MAJOR <major>] [MINOR <minor>] [PATCH <patch>] [TWEAK <tweak>] [PRERELEASE <prerelease>] [BUILD <build>])
|
||||
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="#modify">MODIFY</a> <out-var> <string> [COMPRESS] [MAJOR <major>] [MINOR <minor] [PATCH <patch>] [TWEAK <tweak>] [PRERELEASE <prerelease>] [BUILD <build>] [REQUIRE [PATCH|TWEAK][;...]])
|
||||
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="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>
|
||||
@@ -91,10 +91,10 @@ version(<a class="reference internal" href="#compare">COMPARE</a> <out-var>
|
||||
</section>
|
||||
<section id="parsing">
|
||||
<h2>Parsing<a class="headerlink" href="#parsing" title="Permalink to this heading"></a></h2>
|
||||
<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>
|
||||
<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">[REQUIRE</span><span class="w"> </span><span class="s">[PATCH|TWEAK][;...]]</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 set to a false constant. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will contain the error message otherwise it will be a false constant. 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>
|
||||
<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 set to a false constant. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will contain the error message otherwise it will be a false constant. 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. The optional <code class="docutils literal notranslate"><span class="pre">REQUIRE</span></code> allows forcing the components <code class="docutils literal notranslate"><span class="pre">PATCH</span></code> and <code class="docutils literal notranslate"><span class="pre">TWEAK</span></code> to always be defined.</p>
|
||||
</section>
|
||||
<section id="generating">
|
||||
<h2>Generating<a class="headerlink" href="#generating" title="Permalink to this heading"></a></h2>
|
||||
@@ -105,10 +105,10 @@ version(<a class="reference internal" href="#compare">COMPARE</a> <out-var>
|
||||
</section>
|
||||
<section id="modifying">
|
||||
<h2>Modifying<a class="headerlink" href="#modifying" title="Permalink to this heading"></a></h2>
|
||||
<div class="highlight-cmake notranslate" id="modify"><div class="highlight"><pre><span></span><span class="nb">version</span><span class="p">(</span><span class="s">MODIFY</span><span class="w"> </span><span class="s"><out-var></span><span class="w"> </span><span class="s"><string></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>
|
||||
<div class="highlight-cmake notranslate" id="modify"><div class="highlight"><pre><span></span><span class="nb">version</span><span class="p">(</span><span class="s">MODIFY</span><span class="w"> </span><span class="s"><out-var></span><span class="w"> </span><span class="s"><string></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="w"> </span><span class="s">[REQUIRE</span><span class="w"> </span><span class="s">[PATCH|TWEAK][;...]]</span><span class="p">)</span>
|
||||
</pre></div>
|
||||
</div>
|
||||
<p>Modifies the version provided in <code class="docutils literal notranslate"><span class="pre"><string></span></code> with the components provided. The components <code class="docutils literal notranslate"><span class="pre"><major></span></code>, <code class="docutils literal notranslate"><span class="pre"><minor></span></code>, <code class="docutils literal notranslate"><span class="pre"><patch></span></code> and <code class="docutils literal notranslate"><span class="pre"><tweak></span></code> may have a prefix of <code class="docutils literal notranslate"><span class="pre">+</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code> to add and subtract the value, or no prefix to replace. The result of this operation will be stored as a string in <code class="docutils literal notranslate"><span class="pre"><out-var></span></code>. If a component did not exist in the original, it will be added to the version as a replace operation. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will contain the error message otherwise it will be a false constant.</p>
|
||||
<p>Modifies the version provided in <code class="docutils literal notranslate"><span class="pre"><string></span></code> with the components provided. The components <code class="docutils literal notranslate"><span class="pre"><major></span></code>, <code class="docutils literal notranslate"><span class="pre"><minor></span></code>, <code class="docutils literal notranslate"><span class="pre"><patch></span></code> and <code class="docutils literal notranslate"><span class="pre"><tweak></span></code> may have a prefix of <code class="docutils literal notranslate"><span class="pre">+</span></code> or <code class="docutils literal notranslate"><span class="pre">-</span></code> to add and subtract the value, or no prefix to replace. The result of this operation will be stored as a string in <code class="docutils literal notranslate"><span class="pre"><out-var></span></code>. If a component did not exist in the original, it will be added to the version as a replace operation. If an error occurred, <code class="docutils literal notranslate"><span class="pre"><out-var>_ERROR</span></code> will contain the error message otherwise it will be a false constant. The optional <code class="docutils literal notranslate"><span class="pre">REQUIRE</span></code> allows forcing the components <code class="docutils literal notranslate"><span class="pre">PATCH</span></code> and <code class="docutils literal notranslate"><span class="pre">TWEAK</span></code> to always be defined.</p>
|
||||
</section>
|
||||
<section id="comparing">
|
||||
<h2>Comparing<a class="headerlink" href="#comparing" title="Permalink to this heading"></a></h2>
|
||||
|
||||
Reference in New Issue
Block a user