Skip to content

Commit b3a3438

Browse files
authored
Fix typos and improve clarity in user manual
Corrected typos and improved clarity in user manual.
1 parent 421c4e7 commit b3a3438

1 file changed

Lines changed: 8 additions & 8 deletions

File tree

docs/user_manual.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -255,7 +255,7 @@ If you have downloaded a release artifact containing the packs, you will need to
255255
--search-path path/to/pack1:path/to/pack2
256256
```
257257

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.
259259

260260
##### Alternative query sets
261261

@@ -335,10 +335,10 @@ This will produce a directory (`<output_directory>`) containing the following re
335335
- A list of the guidelines checked, and the status of each guideline ("Compliant", "Violations", "Deviations").
336336
- **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.
337337
- 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.
339339
- 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.
340340
- 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:
342342
- A table of deviation records for which we list:
343343
- An identifier for the coding standards rule the deviation applies to.
344344
- The query identifier that implements the guideline.
@@ -379,7 +379,7 @@ A _deviation record_ can be specified in a `coding-standards.yml` configuration
379379
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.
380380
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.
381381
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.
383383

384384
**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!
385385

@@ -461,7 +461,7 @@ Multiple code identifiers may be passed in a single attribute to apply multiple
461461
[[codeql::misra_deviation("code-identifier-1", "code-identifier-2")]]
462462
```
463463

464-
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.
465465

466466
**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:
467467
* 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
536536

537537
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.
538538

539-
The following example illustrate a possible _deviation permit_:
539+
The following example illustrates a possible _deviation permit_:
540540

541541
```yaml
542542
deviation-permits:
@@ -575,7 +575,7 @@ deviations:
575575

576576
**Importing permits**:
577577
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_.
579579

580580
This means that _deviation permits_ can be made available at build time by any means available.
581581
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:
616616
Application of the guideline re-categorization plan to the analysis results requires an additional post-processing step.
617617
The post-processing step is implemented by the Python script `path/to/codeql-coding-standards/scripts/guideline_recategorization/recategorize.py`.
618618
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.
620620

621621
The script should be invoked as follows:
622622

0 commit comments

Comments
 (0)