summaryrefslogtreecommitdiffstats
path: root/Modules/CMakeAddNewLanguage.txt
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2012-10-30 17:59:07 (GMT)
committerBrad King <brad.king@kitware.com>2012-10-30 18:02:46 (GMT)
commit854369fd45c2fe397637ff5daf687562d45d3896 (patch)
treebb3d767c4622574192efcde0a7faad85a6b87a5c /Modules/CMakeAddNewLanguage.txt
parent259cff94ff81f7b95b7375905fe0e0a292f70dda (diff)
downloadCMake-854369fd45c2fe397637ff5daf687562d45d3896.zip
CMake-854369fd45c2fe397637ff5daf687562d45d3896.tar.gz
CMake-854369fd45c2fe397637ff5daf687562d45d3896.tar.bz2
Document external language support policy
Describe in "Modules/CMakeAddNewLanguage.txt" our policy for external language support.
Diffstat (limited to 'Modules/CMakeAddNewLanguage.txt')
-rw-r--r--Modules/CMakeAddNewLanguage.txt16
1 files changed, 16 insertions, 0 deletions
diff --git a/Modules/CMakeAddNewLanguage.txt b/Modules/CMakeAddNewLanguage.txt
index 6a30dd8..612e1a3 100644
--- a/Modules/CMakeAddNewLanguage.txt
+++ b/Modules/CMakeAddNewLanguage.txt
@@ -1,3 +1,19 @@
+This file provides a few notes to CMake developers about how to add
+support for a new language to CMake. It is also possible to place
+these files in CMAKE_MODULE_PATH within an outside project to add
+languages not supported by upstream CMake. However, this is not
+a fully supported use case.
+
+The implementation behind the scenes of project/enable_language,
+including the compiler/platform modules, is an *internal* API that
+does not make any compatibility guarantees. It is not covered in the
+official reference documentation that is versioned with the source code.
+Maintainers of external language support are responsible for porting
+it to each version of CMake as upstream changes are made. Since
+the API is internal we will not necessarily include notice of any
+changes in release notes.
+
+
CMakeDetermine(LANG)Compiler.cmake -> this should find the compiler for LANG and configure CMake(LANG)Compiler.cmake.in
CMake(LANG)Compiler.cmake.in -> used by CMakeDetermine(LANG)Compiler.cmake