Browse Source

Help: Mention use of project() variables in packages

The `project` command mentions that it sets variables "intended for use
as default values in package metadata". Add a sentence that the
`install` and `export` commands actually do so for CPS. Also add
`COMPAT_VERSION` to the list of relevant options.
Matthew Woehlke 6 months ago
parent
commit
1cd8c8f02a
1 changed files with 6 additions and 2 deletions
  1. 6 2
      Help/command/project.rst

+ 6 - 2
Help/command/project.rst

@@ -149,8 +149,12 @@ By default ``C`` and ``CXX`` are enabled if no language options are given.
 Specify language ``NONE``, or use the ``LANGUAGES`` keyword and list no languages,
 to skip enabling any languages.
 
-The variables set through the ``VERSION``, ``DESCRIPTION`` and ``HOMEPAGE_URL``
-options are intended for use as default values in package metadata and documentation.
+The variables set through the ``VERSION``, ``COMPAT_VERSION``, ``DESCRIPTION``
+and ``HOMEPAGE_URL`` options are intended for use as default values in package
+metadata and documentation. The :command:`export` and :command:`install`
+commands use these accordingly when generating |CPS| package descriptions.
+
+.. |CPS| replace:: Common Package Specification
 
 .. _`Code Injection`: