Skip to content

Learning CodeQL docs: add COBOL notes and remove links #2487

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 3, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/language/global-sphinx-files/global-conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,9 +56,9 @@ def setup(sphinx):
# built documents.
#
# The short X.Y version.
version = u'1.22.1'
version = u'1.23'
# The full version, including alpha/beta/rc tags.
release = u'1.22.1'
release = u'1.23'
copyright = u'2019 Semmle Ltd'
author = u'Semmle Ltd'

Expand Down
1 change: 0 additions & 1 deletion docs/language/learn-ql/cobol/introduce-libraries-cobol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -149,4 +149,3 @@ What next?
----------

- 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>`__.
- Learn more about the query console in `Using the query console <https://lgtm.com/help/lgtm/using-query-console>`__.
6 changes: 3 additions & 3 deletions docs/language/learn-ql/cobol/ql-for-cobol.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,15 +6,15 @@ CodeQL for COBOL
:hidden:

introduce-libraries-cobol


.. include:: ../../support/cobol-note.rst

This page provides an overview of the CodeQL for COBOL documentation that is currently available.

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


Other resources
---------------

- 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.
- For more information about the library for COBOL see the `CodeQL library for COBOL <https://help.semmle.com/qldoc/cobol/>`__.
4 changes: 2 additions & 2 deletions docs/language/ql-training/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ def setup(sphinx):
# built documents.
#
# The short X.Y version.
version = u'1.22'
version = u'1.23'
# The full version, including alpha/beta/rc tags.
release = u'1.22'
release = u'1.23'
copyright = u'2019 Semmle Ltd'
author = u'Semmle Ltd'

Expand Down
5 changes: 5 additions & 0 deletions docs/language/support/cobol-note.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
.. pull-quote:: Important

CodeQL for COBOL is being deprecated after the 1.23 release of CodeQL.
Future releases, starting with 1.24, will no longer contain support for analyzing COBOL source code.
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.
2 changes: 1 addition & 1 deletion docs/language/support/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -80,4 +80,4 @@

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ['read-me-project.rst']
exclude_patterns = ['read-me-project.rst', 'cobol-note.rst']
2 changes: 2 additions & 0 deletions docs/language/support/framework-support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,8 @@ C# built-in support
COBOL built-in support
===================================

.. include:: cobol-note.rst

* Embedded SQL
* Embedded CICS

Expand Down
2 changes: 2 additions & 0 deletions docs/language/support/language-support.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ Customers with any questions should contact their usual Semmle contact with any
If you're not a customer yet, contact us at [email protected]
with any questions you have about language and compiler support.

.. include:: cobol-note.rst

.. csv-table::
:file: versions-compilers.csv
:header-rows: 1
Expand Down