Skip to content

Commit 372243a

Browse files
author
james
committed
docs: some more slide fixes
1 parent 110b02a commit 372243a

File tree

3 files changed

+16
-25
lines changed

3 files changed

+16
-25
lines changed

docs/language/ql-training-rst/cpp/program-representation-cpp.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ Program representation in QL for C/C++
66

77
Semmle :sup:`TM`
88

9-
.. Include information slides here
10-
11-
.. include:: ../slide-snippets/info.rst
9+
.. rst-class:: agenda
1210

1311
Agenda
1412
======

docs/language/ql-training-rst/java/intro-ql-java.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,22 +6,21 @@ Introduction to variant analysis for Java
66

77
Semmle :sup:`TM`
88

9-
.. Include information slides here
9+
.. rst-class:: setup
1010

11-
.. include:: ../slide-snippets/info.rst
11+
Setup
12+
=====
1213

13-
.. Include details of project to analyze here
14+
For this example you should download:
1415

15-
QL snapshot
16-
===========
16+
- `QL for Eclipse <https://help.semmle.com/ql-for-eclipse/Content/WebHelp/install-plugin-free.html>`__
17+
- `Apache Struts snapshot <https://downloads.lgtm.com/snapshots/java/apache/struts/apache-struts-7fd1622-CVE-2018-11776.zip>`__
1718

18-
For the examples in this presentation, we will be analyzing `Apache Struts <https://github.com/apache/struts>`__.
19-
20-
We recommend you download `this historic snapshot <https://downloads.lgtm.com/snapshots/java/apache/struts/apache-struts-7fd1622-CVE-2018-11776.zip>`__ to analyze in QL for Eclipse.
19+
.. note::
2120

22-
Alternatively, you can query the project in `the query console <https://lgtm.com/query/project:1878521151/lang:java//>`__ on LGTM.com.
21+
For this example, we will be analyzing `Apache Struts <https://github.com/apache/struts>`__.
2322

24-
.. note::
23+
You can also query the project in `the query console <https://lgtm.com/query/project:1878521151/lang:java/>`__ on LGTM.com.
2524

2625
Note that results generated in the query console are likely to differ to those generated in the QL plugin as LGTM.com analyzes the most recent revisions of each project that has been added–the snapshot available to download above is based on an historical version of the code base.
2726

docs/language/ql-training-rst/slide-snippets/intro-ql-general.rst

Lines changed: 6 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -45,12 +45,6 @@ Zoom in on the code...
4545
However, there’s no sanity checking, and a developer might call it with an array that’s too short, holding direction information for only one of the thrusters.
4646
The function will then read past the end of the array, and unpredictable results occur.
4747

48-
.. rst-class:: background2
49-
50-
How it all works
51-
================
52-
53-
5448
Write a query...
5549
================
5650

@@ -87,18 +81,18 @@ Find all instances!
8781

8882
- All were fixed with a mid-flight patch.
8983

90-
.. container:: image-box
91-
92-
.. image:: ../_static-training/curiosity2.png
93-
84+
- For more detail on the collaboration between Semmle and NASA, see our case study: `Semmle at NASA: Landing Curiosity safely on Mars <https://semmle.com/case-studies/semmle-nasa-landing-curiosity-safely-mars>`__.
9485

9586
.. note::
9687

9788
The JPL team ran the query across the full Curiosity control software–it identified the original problem, and more than 30 other variants, of which three were in the critical Entry, Descent, and Landing module.
9889

9990
The team addressed all issues, and patched the firmware remotely. Not long after, the Curiosity Rover landed safely on Mars.
100-
101-
For more detail on the collaboration between Semmle and NASA, see our case study: `Semmle at NASA: Landing Curiosity safely on Mars <https://semmle.com/case-studies/semmle-nasa-landing-curiosity-safely-mars>`__.
91+
92+
.. rst-class:: background2
93+
94+
How it all works
95+
================
10296

10397
Analysis overview
10498
=================

0 commit comments

Comments
 (0)