Insert "Results" section and rename files and directories.

This commit is contained in:
Larry Golding 2019-10-15 09:02:25 -07:00
Родитель bb175f3b1a
Коммит 11a03be674
6 изменённых файлов: 15 добавлений и 12 удалений

Просмотреть файл

@ -51,17 +51,18 @@ I've just started writing these tutorials. I'll remove this notice when I think
## Table of contents
- [Introduction](docs/Introduction.md)
- [What is SARIF?](docs/Introduction.md#what-is-sarif)
- [About static analysis tools](docs/Introduction.md#tools)
- [Why SARIF?](docs/Introduction.md#why-sarif)
- [A simple example](docs/Introduction.md#simple-example)
- [The plan for these tutorials](docs/Introduction.md#plan)
- [The basics](docs/Basics.md)
- [Logs, runs, and results](docs/Basics.md#logs-runs-results)
- [Messages](docs/Basics.md#messages)
- [Locations, physical and logical](docs/Basics.md#locations)
- [Artifacts](docs/Basics.md#artifacts)
- [Introduction](docs/1-Introduction.md)
- [What is SARIF?](docs/1-Introduction.md#what-is-sarif)
- [About static analysis tools](docs/1-Introduction.md#tools)
- [Why SARIF?](docs/1-Introduction.md#why-sarif)
- [A simple example](docs/1-Introduction.md#simple-example)
- [The plan for these tutorials](docs/1-Introduction.md#plan)
- [The basics](docs/2-Basics.md)
- [Logs and runs](docs/2-Basics.md#logs-runs)
- [Results](docs/2-Basics.md#results)
- [Messages](docs/2-Basics.md#messages)
- [Locations, physical and logical](docs/2-Basics.md#locations)
- [Artifacts](docs/2-Basics.md#artifacts)
- Beyond the basics
- Property bags
- Invocations

Просмотреть файл

Просмотреть файл

@ -1,6 +1,6 @@
# The Basics
## <a id="logs-runs-results"></a>Logs, runs, and results
## <a id="logs-runs"></a>Logs and runs
A SARIF log is a JSON file.<sup><a href="#note-1">1</a></sup>
It has a required `version` property that must be `"2.1.0"`.
@ -48,6 +48,8 @@ Usually, that's enough, but some tools support plugins &mdash; for example,
code libraries that define additional analysis rules.
SARIF defines the optional `tool.extensions` property to represent plugins.<sup><a href="#note-4">4</a></sup>
## <a id="results"></a>Results
The primary purpose of a run is to hold a set of "results".
A result is an observation about the code.
For most tools, the results represent "issues" &mdash; conditions that might detract from the quality of the code.