Skip to content

Commit ad2da41

Browse files
authored
Merge pull request github#2493 from jf205/deprecate-cobol
Learning CodeQL docs: add COBOL notes and remove links (rc/1.23)
2 parents db30947 + 40920b1 commit ad2da41

File tree

8 files changed

+17
-9
lines changed

8 files changed

+17
-9
lines changed

docs/language/global-sphinx-files/global-conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,9 @@ def setup(sphinx):
5656
# built documents.
5757
#
5858
# The short X.Y version.
59-
version = u'1.22.1'
59+
version = u'1.23'
6060
# The full version, including alpha/beta/rc tags.
61-
release = u'1.22.1'
61+
release = u'1.23'
6262
copyright = u'2019 Semmle Ltd'
6363
author = u'Semmle Ltd'
6464

docs/language/learn-ql/cobol/introduce-libraries-cobol.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -149,4 +149,3 @@ What next?
149149
----------
150150

151151
- Find out more about QL in the `QL language handbook <https://help.semmle.com/QL/ql-handbook/index.html>`__ and `QL language specification <https://help.semmle.com/QL/ql-spec/language.html>`__.
152-
- Learn more about the query console in `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__.

docs/language/learn-ql/cobol/ql-for-cobol.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,15 @@ CodeQL for COBOL
66
:hidden:
77

88
introduce-libraries-cobol
9-
9+
10+
.. include:: ../../support/cobol-note.rst
11+
1012
This page provides an overview of the CodeQL for COBOL documentation that is currently available.
1113

12-
- `Basic COBOL query <https://lgtm.com/help/lgtm/console/ql-cobol-basic-example>`__ describes how to write and run queries using LGTM.
1314
- :doc:`Introducing the CodeQL libraries for COBOL <introduce-libraries-cobol>` introduces the standard libraries used to write queries for COBOL code.
1415

1516

1617
Other resources
1718
---------------
1819

19-
- For the queries used in LGTM, display a `COBOL query <https://lgtm.com/search?q=language%3Acobol&t=rules>`__ and click **Open in query console** to see the code used to find alerts.
2020
- For more information about the library for COBOL see the `CodeQL library for COBOL <https://help.semmle.com/qldoc/cobol/>`__.

docs/language/ql-training/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,9 @@ def setup(sphinx):
8686
# built documents.
8787
#
8888
# The short X.Y version.
89-
version = u'1.22'
89+
version = u'1.23'
9090
# The full version, including alpha/beta/rc tags.
91-
release = u'1.22'
91+
release = u'1.23'
9292
copyright = u'2019 Semmle Ltd'
9393
author = u'Semmle Ltd'
9494

docs/language/support/cobol-note.rst

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
.. pull-quote:: Important
2+
3+
CodeQL for COBOL is being deprecated after the 1.23 release of CodeQL.
4+
Future releases, starting with 1.24, will no longer contain support for analyzing COBOL source code.
5+
We are not aware of any customers who will be affected by this change. If you do have any concerns, please contact your account manager.

docs/language/support/conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@
8080

8181
# List of patterns, relative to source directory, that match files and
8282
# directories to ignore when looking for source files.
83-
exclude_patterns = ['read-me-project.rst']
83+
exclude_patterns = ['read-me-project.rst', 'cobol-note.rst']

docs/language/support/framework-support.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,8 @@ C# built-in support
2424
COBOL built-in support
2525
===================================
2626

27+
.. include:: cobol-note.rst
28+
2729
* Embedded SQL
2830
* Embedded CICS
2931

docs/language/support/language-support.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ Customers with any questions should contact their usual Semmle contact with any
1010
If you're not a customer yet, contact us at [email protected]
1111
with any questions you have about language and compiler support.
1212

13+
.. include:: cobol-note.rst
14+
1315
.. csv-table::
1416
:file: versions-compilers.csv
1517
:header-rows: 1

0 commit comments

Comments
 (0)