summaryrefslogtreecommitdiffstats
path: root/Help/variable/CMAKE_LANG_COMPILER.rst
diff options
context:
space:
mode:
authorFred Baksik <fdk17@ftml.net>2020-07-15 19:03:46 (GMT)
committerFred Baksik <fdk17@ftml.net>2020-08-03 16:34:46 (GMT)
commitdb486da2655c49ac9f6d770fd7d4475aa5354b9f (patch)
tree7720f572c98f115a481318caa149fe57d9afba14 /Help/variable/CMAKE_LANG_COMPILER.rst
parentdeec2f587cd0bd08ee6866d06b9600dee98af910 (diff)
downloadCMake-db486da2655c49ac9f6d770fd7d4475aa5354b9f.zip
CMake-db486da2655c49ac9f6d770fd7d4475aa5354b9f.tar.gz
CMake-db486da2655c49ac9f6d770fd7d4475aa5354b9f.tar.bz2
Toolchain: Update documentation for initial compiler flags
Diffstat (limited to 'Help/variable/CMAKE_LANG_COMPILER.rst')
-rw-r--r--Help/variable/CMAKE_LANG_COMPILER.rst25
1 files changed, 25 insertions, 0 deletions
diff --git a/Help/variable/CMAKE_LANG_COMPILER.rst b/Help/variable/CMAKE_LANG_COMPILER.rst
index 89df495..e694b33 100644
--- a/Help/variable/CMAKE_LANG_COMPILER.rst
+++ b/Help/variable/CMAKE_LANG_COMPILER.rst
@@ -5,3 +5,28 @@ The full path to the compiler for ``LANG``.
This is the command that will be used as the ``<LANG>`` compiler. Once
set, you can not change this variable.
+
+Usage
+^^^^^
+
+This variable can be set by the user during the first time a build tree is configured.
+
+If a non-full path value is supplied then CMake will resolve the full path of
+the compiler.
+
+The variable could be set in a user supplied toolchain file or via `-D` on the command line.
+
+.. note::
+ Options that are required to make the compiler work correctly can be included
+ as items in a list; they can not be changed.
+
+.. code-block:: cmake
+
+ #set within user supplied toolchain file
+ set(CMAKE_C_COMPILER /full/path/to/qcc --arg1 --arg2)
+
+or
+
+.. code-block:: console
+
+ $ cmake ... -DCMAKE_C_COMPILER='qcc;--arg1;--arg2'