xaymar/cmake-version
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

code: Attempt to fix REQUIRE behavior

Browse Source
This commit is contained in:
Michael Fabian 'Xaymar' Dirks
2023-04-23 01:45:15 +02:00
parent 16bfa9568c
commit 6f4488a833
2 changed files with 39 additions and 44 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/index.rst
+6
View File
@@ -31,6 +31,8 @@ Parsing
Attempts to parse the version in ``<string>`` and stores the individual compoents into ``<out-var>_<component>``. If a component is not present in the given version, it will be set to a false constant. If an error occurred, ``<out-var>_ERROR`` will contain the error message otherwise it will be a false constant. The ``PRERELEASE`` and ``BUILD`` components support the dot-separation specifier and will be turned into a list if they are encountered. The optional ``REQUIRE`` allows forcing the components ``PATCH`` and ``TWEAK`` to always be defined.
It is necessary to include a ``;`` for the ``REQUIRE`` parameter, even if there is only one required part.
Generating
^^^^^^^^^^
@@ -42,6 +44,8 @@ Generating
Generates a version from the components provided and stores the result in ``<out-var>``. The components ``<major>`` and ``<minor>`` will default to ``0`` if not provided. If an error occurred, ``<out-var>_ERROR`` will contain the error message otherwise it will be a false constant. The ``PRERELEASE`` and ``BUILD`` components support the dot-separation specifier and will be converted from a list if encountered. The optional ``REQUIRE`` allows forcing the components ``PATCH`` and ``TWEAK`` to always be defined.
It is necessary to include a ``;`` for the ``REQUIRE`` parameter, even if there is only one required part.
Modifying
^^^^^^^^^
@@ -53,6 +57,8 @@ Modifying
Modifies the version provided in ``<string>`` with the components provided. The components ``<major>``, ``<minor>``, ``<patch>`` and ``<tweak>`` may have a prefix of ``+`` or ``-`` to add and subtract the value, or no prefix to replace. The result of this operation will be stored as a string in ``<out-var>``. If a component did not exist in the original, it will be added to the version as a replace operation. If an error occurred, ``<out-var>_ERROR`` will contain the error message otherwise it will be a false constant. The optional ``REQUIRE`` allows forcing the components ``PATCH`` and ``TWEAK`` to always be defined.
It is necessary to include a ``;`` for the ``REQUIRE`` parameter, even if there is only one required part.
Comparing
^^^^^^^^^