Each rule page has an "Automated Detection" (AD) section, describing which tools can detect violations of the rule. This section contains a table. Each row of the table contains information for a specific version of a tool. A row in the AD table has the following format.
Tool | Version | Checker | Description |
|---|---|---|---|
Hyperlinked name of the tool | The version of the tool | Checker Name 1 Checker Name 2 Checker Name 3 ... | Checker Description 1 Checker Description 2 Checker Description 3 ... |
The information in these tables is periodically aggregated for each tool. A wiki page is then updated for each tool with the aggregated data, showing all of the rules that the tool can detect. For example, the Clang page displays all of the rules detected by various checkers in the Clang compiler.
This aggregation process is automatic. In order for the process to pick up your changes, you should adhere to certain guidelines when entering data into the AD tables.
- The Tool column contains the name of the tool. This name must be the same wherever it appears. The name should be hyperlinked to the appropriate tool page.
- The Version column contains the version of the tool to which this information pertains. This
- Each checker name should be provided on a separate line in the Checker column
- Each checker description should be provided on a separate line in the Description column, adjacent to the associated checker.
At this time, information for all versions of a given tool are provided on the same tool page.