diff options
author | Brad King <brad.king@kitware.com> | 2023-01-23 15:41:33 (GMT) |
---|---|---|
committer | Kitware Robot <kwrobot@kitware.com> | 2023-01-23 15:41:41 (GMT) |
commit | f9f34eb11143e5c5c1daee4aa2867139cf930aa4 (patch) | |
tree | aac9a26eca41b01bb6afbf926e3f50abd173620a /Help | |
parent | 709bc0368f9a34577309698c3c7b246c56b75c17 (diff) | |
parent | b787be2714662eea6ec7fe8ef30ab40d9effa792 (diff) | |
download | CMake-f9f34eb11143e5c5c1daee4aa2867139cf930aa4.zip CMake-f9f34eb11143e5c5c1daee4aa2867139cf930aa4.tar.gz CMake-f9f34eb11143e5c5c1daee4aa2867139cf930aa4.tar.bz2 |
Merge topic 'improve_supported_language_docs'
b787be2714 Help: Update supported languages in project and enable_language
Acked-by: Kitware Robot <kwrobot@kitware.com>
Merge-request: !8101
Diffstat (limited to 'Help')
-rw-r--r-- | Help/command/SUPPORTED_LANGUAGES.txt | 25 | ||||
-rw-r--r-- | Help/command/enable_language.rst | 21 | ||||
-rw-r--r-- | Help/command/project.rst | 16 |
3 files changed, 31 insertions, 31 deletions
diff --git a/Help/command/SUPPORTED_LANGUAGES.txt b/Help/command/SUPPORTED_LANGUAGES.txt new file mode 100644 index 0000000..a98c07a --- /dev/null +++ b/Help/command/SUPPORTED_LANGUAGES.txt @@ -0,0 +1,25 @@ + +Supported languages are ``C``, ``CXX`` (i.e. C++), ``CSharp`` (i.e. C#), ``CUDA``, +``OBJC`` (i.e. Objective-C), ``OBJCXX`` (i.e. Objective-C++), ``Fortran``, ``HIP``, +``ISPC``, ``Swift``, ``ASM``, ``ASM_NASM``, ``ASM_MARMASM``, ``ASM_MASM``, and ``ASM-ATT``. + + .. versionadded:: 3.8 + Added ``CSharp`` and ``CUDA`` support. + + .. versionadded:: 3.15 + Added ``Swift`` support. + + .. versionadded:: 3.16 + Added ``OBJC`` and ``OBJCXX`` support. + + .. versionadded:: 3.18 + Added ``ISPC`` support. + + .. versionadded:: 3.21 + Added ``HIP`` support. + + .. versionadded:: 3.26 + Added ``ASM_MARMASM`` support. + +If enabling ``ASM``, list it last so that CMake can check whether +compilers for other languages like ``C`` work for assembly too. diff --git a/Help/command/enable_language.rst b/Help/command/enable_language.rst index d9103b8..21b38ba 100644 --- a/Help/command/enable_language.rst +++ b/Help/command/enable_language.rst @@ -9,24 +9,13 @@ Enable languages (CXX/C/OBJC/OBJCXX/Fortran/etc) Enables support for the named languages in CMake. This is the same as the :command:`project` command but does not create any of the extra -variables that are created by the project command. Example languages -are ``CXX``, ``C``, ``CUDA``, ``OBJC``, ``OBJCXX``, ``Fortran``, -``HIP``, ``ISPC``, and ``ASM``. +variables that are created by the project command. -.. versionadded:: 3.8 - Added ``CUDA`` support. +.. include:: SUPPORTED_LANGUAGES.txt -.. versionadded:: 3.16 - Added ``OBJC`` and ``OBJCXX`` support. - -.. versionadded:: 3.18 - Added ``ISPC`` support. - -.. versionadded:: 3.21 - Added ``HIP`` support. - -If enabling ``ASM``, enable it last so that CMake can check whether -compilers for other languages like ``C`` work for assembly too. +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. This command must be called in file scope, not in a function call. Furthermore, it must be called in the highest directory common to all diff --git a/Help/command/project.rst b/Help/command/project.rst index 4e57d09..ab93f3d 100644 --- a/Help/command/project.rst +++ b/Help/command/project.rst @@ -102,23 +102,9 @@ The options are: Can also be specified without ``LANGUAGES`` keyword per the first, short signature. Selects which programming languages are needed to build the project. - Supported languages include ``C``, ``CXX`` (i.e. C++), ``CUDA``, - ``OBJC`` (i.e. Objective-C), ``OBJCXX``, ``Fortran``, ``HIP``, ``ISPC``, and ``ASM``. - 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. - .. versionadded:: 3.8 - Added ``CUDA`` support. +.. include:: SUPPORTED_LANGUAGES.txt - .. versionadded:: 3.16 - Added ``OBJC`` and ``OBJCXX`` support. - - .. versionadded:: 3.18 - Added ``ISPC`` support. - - If enabling ``ASM``, list it last so that CMake can check whether - compilers for other languages like ``C`` work for assembly too. The variables set through the ``VERSION``, ``DESCRIPTION`` and ``HOMEPAGE_URL`` options are intended for use as default values in package metadata and documentation. |