You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/user_manual.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -255,7 +255,7 @@ If you have downloaded a release artifact containing the packs, you will need to
255
255
--search-path path/to/pack1:path/to/pack2
256
256
```
257
257
258
-
Alternatively, the packs can be made available to CodeQL without specification on the comamnd line by placing them inside the distribution under the `qlpacks/codeql/` directory, or placed inside a directory adjacent to the folder containing the distribution.
258
+
Alternatively, the packs can be made available to CodeQL without specification on the command line by placing them inside the distribution under the `qlpacks/codeql/` directory, or placed inside a directory adjacent to the folder containing the distribution.
259
259
260
260
##### Alternative query sets
261
261
@@ -335,10 +335,10 @@ This will produce a directory (`<output_directory>`) containing the following re
335
335
- A list of the guidelines checked, and the status of each guideline ("Compliant", "Violations", "Deviations").
336
336
-**Note:** The `Deviations` status is **only** shown when the database has been build with a configuration to _report deviated alerts_ and analyzed with a _deviation alert suppression query_. The section on _Deviation records_ outlines how this can be achieved.
337
337
- An **Analysis Integrity Report** which summarizes any issues that were identified in the creation of the database, which can be reviewed to determine the extent to which these issues may have impacted the generated results. This includes:
338
-
- A list of recoverable errors, where a specific piece of syntax was not handled, but the error could be recovered from. These a further sub-divided into "user code" errors and "third-party" errors.
338
+
- A list of recoverable errors, where a specific piece of syntax was not handled, but the error could be recovered from. These are further sub-divided into "user code" errors and "third-party" errors.
339
339
- A list of unrecoverable errors, which affect either entire files or entire compilations. These are also further sub-divided into "user code" errors and "third-party" errors.
340
340
- A list of the files analyzed.
341
-
- A **Deviations Report** which reports the deviation records that where included during the creation of the database, which can be used to audit the applied deviations. The includes:
341
+
- A **Deviations Report** which reports the deviation records that were included during the creation of the database, which can be used to audit the applied deviations. The includes:
342
342
- A table of deviation records for which we list:
343
343
- An identifier for the coding standards rule the deviation applies to.
344
344
- The query identifier that implements the guideline.
@@ -379,7 +379,7 @@ A _deviation record_ can be specified in a `coding-standards.yml` configuration
379
379
The deviation mechanism, by default, works by **excluding** alerts for which there exists an associated _deviation record_, with exclusion being defined as not reporting the alert.
380
380
This default behavior can be changed by specify the top level property `report-deviated-alerts: true` in any `coding-standards.yml` that is added to the database.
381
381
This property can be combined with the query `path/to/codeql-coding-standards/cpp/common/src/codingstandards/cpp/deviations/DeviationsSuppression.ql` that can be added to a CodeQL database analyze command to generate suppression information that is added to the resulting SARIF output in the form of [suppressions](https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html#_Toc34317661) that is part of [result](https://docs.oasis-open.org/sarif/sarif/v2.1.0/os/sarif-v2.1.0-os.html#_Toc34317638) object.
382
-
The rational for the default behavior is that GitHub Code Scanning does not support the `suppressions` property of a `result` object and displays the alert even though it is suppressed.
382
+
The rationale for the default behavior is that GitHub Code Scanning does not support the `suppressions` property of a `result` object and displays the alert even though it is suppressed.
383
383
384
384
**Note:** It is important to create a database with the property `report-deviated-alerts: true` set and analyzed with the alert suppression query `path/to/codeql-coding-standards/cpp/common/src/codingstandards/cpp/deviations/DeviationsSuppression.ql` when the **Guideline Compliance Summary Report****must** include deviation statuses!
385
385
@@ -461,7 +461,7 @@ Multiple code identifiers may be passed in a single attribute to apply multiple
Note - considation should be taken to ensure the use of custom attributes for deviations is compatible with your chosen language version, compiler, compiler configuration and coding standard.
464
+
Note - consideration should be taken to ensure the use of custom attributes for deviations is compatible with your chosen language version, compiler, compiler configuration and coding standard.
465
465
466
466
**Use of attributes in C Coding Standards**: The C Standard introduces attributes in C23, however some compilers support attributes as a language extension in prior versions. You should:
467
467
* Confirm that your compiler supports attributes for your chosen compiler configuration, if necessary as a language extension.
@@ -536,7 +536,7 @@ Deviation permits are a mechanism to simplify the documentation of many deviatio
536
536
537
537
A _deviation permit_ **must** be specified in a `deviation-records` section part of a `coding-standards.yml` file that **must** be anywhere in the source repository. Every _deviation permit_ **must** specify a free-form `permit-id` property that **must** contain a globally unique identifier and **may** specify any of the allowed properties listed above.
538
538
539
-
The following example illustrate a possible _deviation permit_:
539
+
The following example illustrates a possible _deviation permit_:
540
540
541
541
```yaml
542
542
deviation-permits:
@@ -575,7 +575,7 @@ deviations:
575
575
576
576
**Importing permits**:
577
577
The used _deviation permits_ **must** be present in the source directory during the build of the CodeQL database.
578
-
Unlike _deviation records_ their location in the source directory does not impact their scope which is determined solemnly by the _deviation records_ referring to the _deviation permits_.
578
+
Unlike _deviation records_ their location in the source directory does not impact their scope which is determined solely by the _deviation records_ referring to the _deviation permits_.
579
579
580
580
This means that _deviation permits_ can be made available at build time by any means available.
581
581
An example of importing _deviation permits_ is through a [Git Submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules) that contains a repository of allowed _deviation permits_.
@@ -616,7 +616,7 @@ guideline-recategorizations:
616
616
Application of the guideline re-categorization plan to the analysis results requires an additional post-processing step.
617
617
The post-processing step is implemented by the Python script `path/to/codeql-coding-standards/scripts/guideline_recategorization/recategorize.py`.
618
618
The script will update the `external/<standard>/obligation/<category>` tag for each query implementing a recategorized guideline such that `<category>` is equal to the new category and
619
-
add the tag `external/<standard>/original-obligation/<category` to each query implementing a recategorized guideline such that `<category>` reflects the orignal category.
619
+
add the tag `external/<standard>/original-obligation/<category` to each query implementing a recategorized guideline such that `<category>` reflects the original category.
0 commit comments