Merge pull request #1708 from felicity-semmle/support/add-note

Support: add note about compiler versions

Author: jf205

change-notes/support/README.md

@@ -0,0 +1,6 @@
+# Files moved to ``docs`` directory
+
+Now that all of the QL documentation is in this repository,
+notes on the languages, compilers, and frameworks supported have moved.
+They're now stored as part of the Sphinx ``support`` project with the other documentation:
+``docs/ql-documentation/support``.

change-notes/support/framework-support.rst

@@ -1,3 +1,58 @@
-.. This includes the file maintained in the QL repository
+Frameworks and libraries
+########################
 
-.. include:: ../../../change-notes/support/framework-support.rst
+The QL libraries and queries in version |version| have been explicitly checked against the libraries and frameworks listed below.
+
+.. pull-quote::
+
+    Tip
+    
+    If you're interested in other libraries or frameworks, you can extend the analysis to cover them. 
+    For example, by extending the data flow libraries to include data sources and sinks for additional libraries or frameworks.
+
+.. There is currently no built-in support for libraries or frameworks for C/C++.
+
+C# built-in support
+================================
+
+.. csv-table:: 
+     :file: csharp-frameworks.csv
+     :header-rows: 1
+     :class: fullWidthTable
+     :widths: auto
+
+COBOL built-in support
+===================================
+
+* Embedded SQL
+* Embedded CICS
+
+
+Java built-in support
+==================================
+
+.. csv-table:: 
+     :file: java-frameworks.csv
+     :header-rows: 1
+     :class: fullWidthTable
+     :widths: auto
+
+
+JavaScript and TypeScript built-in support
+=======================================================
+
+.. csv-table:: 
+     :file: javascript-typescript-frameworks.csv
+     :header-rows: 1
+     :class: fullWidthTable
+     :widths: auto
+
+
+Python built-in support
+====================================
+
+.. csv-table:: 
+     :file: python-frameworks.csv
+     :header-rows: 1
+     :class: fullWidthTable
+     :widths: auto

change-notes/support/language-support.rst

@@ -1,7 +1,7 @@
 Supported languages and frameworks
 ##################################
 
-These pages describe the languages and frameworks supported in the latest release of QL and LGTM. 
+These pages describe the languages and frameworks supported in the latest enterprise release of QL and LGTM. 
 Users of `LGTM.com <https://lgtm.com/>`_ may find that additional features are supported because it's updated more frequently.
 
 For details see:

…ange-notes/support/csharp-frameworks.csv …umentation/support/csharp-frameworks.csvchange-notes/support/csharp-frameworks.csv renamed to docs/ql-documentation/support/csharp-frameworks.csv change-notes/support/csharp-frameworks.csv renamed to docs/ql-documentation/support/csharp-frameworks.csv

@@ -1,3 +1,26 @@
-.. This includes the file maintained in the QL repository
+Languages and compilers
+#######################
 
-.. include:: ../../../change-notes/support/language-support.rst
+QL and LGTM version |version| support analysis of the following languages compiled by the following compilers.
+
+Note that where there are several versions or dialects of a language, the supported variants are listed.
+If your code requires a particular version of a compiler, check that this version is included below. 
+Customers with any questions should contact their usual Semmle contact with any questions. 
+If you're not a customer yet, contact us at info@semmle.com 
+with any questions you have about language and compiler support.
+
+.. csv-table::
+     :file: versions-compilers.csv
+     :header-rows: 1
+     :widths: auto
+     :stub-columns: 1
+
+.. container:: footnote-group
+
+    .. [1] Support for the Arm Compiler (armcc) is preliminary.
+    .. [2] In addition, support is included for the preview features of C# 8.0 and .NET Core 3.0.
+    .. [3] The best results are achieved with COBOL code that stays close to the ANSI 85 standard.  
+    .. [4] Builds that execute on Java 6 to 12 can be analyzed. The analysis understands Java 12 language features.
+    .. [5] ECJ is supported when the build invokes it via the Maven Compiler plugin or the Takari Lifecycle plugin.
+    .. [6] JSX and Flow code, YAML, JSON, HTML, and XML files may also be analyzed with JavaScript files. 
+    .. [7] TypeScript analysis is performed by running the JavaScript extractor with TypeScript enabled. This is the default for LGTM.