Skip to content

Commit 782e5ed

Browse files
committed
docs: Improve documentation of VERSION file
1 parent d306efa commit 782e5ed

File tree

1 file changed

+10
-6
lines changed

1 file changed

+10
-6
lines changed

docs/develop/directory-structure.rst

+10-6
Original file line numberDiff line numberDiff line change
@@ -114,11 +114,6 @@ Files
114114
Conan recipe for the ``cloe`` meta-package
115115
(s. :doc:`Understanding Cloe Packages<../usage/understanding-cloe-packages>`).
116116

117-
``conantest.py``
118-
119-
Conan execution profile for running the provided system tests
120-
(s. ``tests/``).
121-
122117
``LICENSE``
123118

124119
Terms and conditions for use, reproduction and distribution of Cloe.
@@ -139,9 +134,18 @@ Files
139134
By default, the Cloe version is determined using ``git describe`` (try the
140135
command). Alternatively, the Cloe version can be directly specified by creating
141136
the ``VERSION`` file, which must contain the version string only
142-
(e.g. ``0.18.0-rc1``). You can verify that this version is used by
137+
(e.g. ``0.18.0-nightly``). You can verify that this version is used by
143138
executing::
144139

145140
make -f Makefile.package info-version
146141

147142
The ``VERSION`` file is not checked in to the repository.
143+
144+
Generally we want packages to be immutable. So if I refer to
145+
``cloe/0.18.0-rc1``, I expect to always get the package built from the
146+
code checked out from the ``v0.18.0-rc1`` tag.
147+
On the other hand, during development it can lead to a lot of unnecessary
148+
re-compilation, especially when structuring commits and rebasing. To this
149+
end, we can set ``VERSION`` to contain a version with a suffix that is
150+
understood to be transient, such as ``0.18.0-nightly`` or the name of the
151+
branch in question, such as ``master``.

0 commit comments

Comments
 (0)