meson: explain GIT_VERSION and PROJECT_VERSION

Fixes #11415.
2020-02-28 16:54:33 +01:00
parent 62641751d5
commit 6ffeca8c8f
2 changed files with 11 additions and 2 deletions
@@ -1 +1,8 @@
+/* Detailed project version that includes git commit when not built from a release.
+ * Use this in preference to PROJECT_VERSION, with the following exceptions:
+ * - where a simplified form is expected for compatiblity, for example
+ *   'udevadm version',
+ * - where a simplified machine-parsable form is more useful, for example
+ *   pkgconfig files and version information written to binary files.
+ */
 #define GIT_VERSION "@VCS_TAG@"