Skip to content

Commit c8c1c6e

Browse files
committed
Address review comments
1 parent 2e0915e commit c8c1c6e

9 files changed

+19
-19
lines changed

docs/codeql/codeql-language-guides/analyzing-data-flow-in-cpp.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ Exercise 2: Write a query that finds all hard-coded strings used to create a ``h
314314

315315
Exercise 3: Write a class that represents flow sources from ``getenv``. (`Answer <#exercise-3>`__)
316316

317-
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``getenv`` to ``gethostbyname``. (`Answer <#exercise-4>`__)
317+
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``getenv`` to ``gethostbyname``. (`Answer <#exercise-4>`__ `Answer as a path query <#path-query-example>`__)
318318

319319
Answers
320320
-------
@@ -411,7 +411,7 @@ Exercise 4
411411
GetenvToGethostbynameFlow::flow(source, sink)
412412
select getenv, fc
413413
414-
Path Query Example
414+
Path query example
415415
~~~~~~~~~~~~~~~~~~
416416

417417
Here is the answer to exercise 4 above, converted into a path query:

docs/codeql/codeql-language-guides/analyzing-data-flow-in-csharp.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -287,7 +287,7 @@ Exercise 2: Find all hard-coded strings passed to ``System.Uri``, using global d
287287

288288
Exercise 3: Define a class that represents flow sources from ``System.Environment.GetEnvironmentVariable``. (`Answer <#exercise-3>`__)
289289

290-
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``System.Environment.GetEnvironmentVariable`` to ``System.Uri``. (`Answer <#exercise-4>`__)
290+
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``System.Environment.GetEnvironmentVariable`` to ``System.Uri``. (`Answer <#exercise-4>`__ `Answer as a path query <#path-query-example>`__)
291291

292292
Extending library data flow
293293
---------------------------
@@ -537,7 +537,7 @@ This can be adapted from the ``SystemUriFlow`` class:
537537
}
538538
}
539539
540-
Path Query Example
540+
Path query example
541541
~~~~~~~~~~~~~~~~~~
542542

543543
Here is the answer to exercise 4 above, converted into a path query:

docs/codeql/codeql-language-guides/analyzing-data-flow-in-go.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -252,7 +252,7 @@ Exercise 2: Write a query that finds all hard-coded strings used to create a ``u
252252

253253
Exercise 3: Write a class that represents flow sources from ``os.Getenv(..)``. (`Answer <#exercise-3>`__)
254254

255-
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``os.Getenv`` to ``url.URL``. (`Answer <#exercise-4>`__)
255+
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``os.Getenv`` to ``url.URL``. (`Answer <#exercise-4>`__ `Answer as a path query <#path-query-example>`__)
256256

257257
Answers
258258
-------
@@ -358,7 +358,7 @@ Exercise 4
358358
where GetenvToURLFlow::flow(src, sink)
359359
select src, "This environment variable constructs a URL $@.", sink, "here"
360360
361-
Path Query Example
361+
Path query example
362362
~~~~~~~~~~~~~~~~~~
363363

364364
Here is the answer to exercise 4 above, converted into a path query:

docs/codeql/codeql-language-guides/analyzing-data-flow-in-java.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ Exercise 2: Write a query that finds all hard-coded strings used to create a ``j
262262

263263
Exercise 3: Write a class that represents flow sources from ``java.lang.System.getenv(..)``. (`Answer <#exercise-3>`__)
264264

265-
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``getenv`` to ``java.net.URL``. (`Answer <#exercise-4>`__)
265+
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from ``getenv`` to ``java.net.URL``. (`Answer <#exercise-4>`__ `Answer as a path query <#path-query-example>`__)
266266

267267
Answers
268268
-------
@@ -361,7 +361,7 @@ Exercise 4
361361
where GetenvToURLFlow::flow(src, sink)
362362
select src, "This environment variable constructs a URL $@.", sink, "here"
363363
364-
Path Query Example
364+
Path query example
365365
~~~~~~~~~~~~~~~~~~
366366

367367
Here is the answer to exercise 4 above, converted into a path query:

docs/codeql/codeql-language-guides/analyzing-data-flow-in-javascript-and-typescript.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -456,7 +456,7 @@ Exercise 3: Write a class which represents flow sources from the array elements
456456
Hint: array indices are properties with numeric names; you can use regular expression matching to check this. (`Answer <#exercise-3>`__)
457457
458458
Exercise 4: Using the answers from 2 and 3, write a query which finds all global data flow paths from array elements of the result of a call to the ``tagName`` argument to the
459-
``createElement`` function. (`Answer <#exercise-4>`__)
459+
``createElement`` function. (`Answer <#exercise-4>`__ `Answer as a path query <#path-query-example>`__)
460460
461461
Answers
462462
-------
@@ -541,7 +541,7 @@ Exercise 4
541541
where HardCodedTagNameFlow::flow(source, sink)
542542
select source, sink
543543
544-
Path Query Example
544+
Path query example
545545
~~~~~~~~~~~~~~~~~~
546546
547547
Here is the answer to exercise 4 above, converted into a path query:

docs/codeql/codeql-language-guides/analyzing-data-flow-in-python.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -354,10 +354,10 @@ This data flow configuration tracks data flow from environment variables to open
354354
select fileOpen, "This call to 'os.open' uses data from $@.",
355355
environment, "call to 'os.getenv'"
356356
357-
Path Query Example
357+
Path query example
358358
~~~~~~~~~~~~~~~~~~
359359

360-
Here is the first example above, converted into a path query:
360+
Here is the network input example above, converted into a path query:
361361

362362
.. code-block:: ql
363363
@@ -397,7 +397,7 @@ For more information, see "`Creating path queries <https://codeql.github.com/doc
397397
Further reading
398398
---------------
399399

400-
- `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__ in the GitHub documentation.
400+
- `Creating path queries <https://codeql.github.com/docs/writing-codeql-queries/creating-path-queries/>`__.
401401

402402

403403
.. include:: ../reusables/python-further-reading.rst

docs/codeql/codeql-language-guides/analyzing-data-flow-in-ruby.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -372,10 +372,10 @@ The following global data-flow query finds calls to ``File.open`` where the file
372372
select fileOpen, "This call to 'File.open' uses data from $@.", environment,
373373
"an environment variable"
374374
375-
Path Query Example
375+
Path query example
376376
~~~~~~~~~~~~~~~~~~
377377

378-
Here is the first example above, converted into a path query:
378+
Here is the taint-tracking example above, converted into a path query:
379379

380380
.. code-block:: ql
381381

docs/codeql/codeql-language-guides/analyzing-data-flow-in-rust.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,10 +231,10 @@ The following global taint-tracking query finds places where a string literal is
231231
where ConstantPasswordFlow::flow(sourceNode, sinkNode)
232232
select sinkNode, "The value $@ is used as a constant password.", sourceNode, sourceNode.toString()
233233
234-
Path Query Example
234+
Path query example
235235
~~~~~~~~~~~~~~~~~~
236236

237-
Here is the first example above, converted into a path query:
237+
Here is the taint-tracking example above, converted into a path query:
238238

239239
.. code-block:: ql
240240

docs/codeql/codeql-language-guides/analyzing-data-flow-in-swift.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -278,10 +278,10 @@ The following global taint-tracking query finds places where a value from a remo
278278
where SqlInjectionFlow::flow(sourceNode, sinkNode)
279279
select sinkNode, "This query depends on a $@.", sourceNode, "user-provided value"
280280
281-
Path Query Example
281+
Path query example
282282
~~~~~~~~~~~~~~~~~~
283283

284-
Here is the first example above, converted into a path query:
284+
Here is the string literal example above, converted into a path query:
285285

286286
.. code-block:: ql
287287

0 commit comments

Comments
 (0)