Insert "Results" section and rename files and directories.
This commit is contained in:
Родитель
bb175f3b1a
Коммит
11a03be674
23
README.md
23
README.md
|
@ -51,17 +51,18 @@ I've just started writing these tutorials. I'll remove this notice when I think
|
||||||
|
|
||||||
## Table of contents
|
## Table of contents
|
||||||
|
|
||||||
- [Introduction](docs/Introduction.md)
|
- [Introduction](docs/1-Introduction.md)
|
||||||
- [What is SARIF?](docs/Introduction.md#what-is-sarif)
|
- [What is SARIF?](docs/1-Introduction.md#what-is-sarif)
|
||||||
- [About static analysis tools](docs/Introduction.md#tools)
|
- [About static analysis tools](docs/1-Introduction.md#tools)
|
||||||
- [Why SARIF?](docs/Introduction.md#why-sarif)
|
- [Why SARIF?](docs/1-Introduction.md#why-sarif)
|
||||||
- [A simple example](docs/Introduction.md#simple-example)
|
- [A simple example](docs/1-Introduction.md#simple-example)
|
||||||
- [The plan for these tutorials](docs/Introduction.md#plan)
|
- [The plan for these tutorials](docs/1-Introduction.md#plan)
|
||||||
- [The basics](docs/Basics.md)
|
- [The basics](docs/2-Basics.md)
|
||||||
- [Logs, runs, and results](docs/Basics.md#logs-runs-results)
|
- [Logs and runs](docs/2-Basics.md#logs-runs)
|
||||||
- [Messages](docs/Basics.md#messages)
|
- [Results](docs/2-Basics.md#results)
|
||||||
- [Locations, physical and logical](docs/Basics.md#locations)
|
- [Messages](docs/2-Basics.md#messages)
|
||||||
- [Artifacts](docs/Basics.md#artifacts)
|
- [Locations, physical and logical](docs/2-Basics.md#locations)
|
||||||
|
- [Artifacts](docs/2-Basics.md#artifacts)
|
||||||
- Beyond the basics
|
- Beyond the basics
|
||||||
- Property bags
|
- Property bags
|
||||||
- Invocations
|
- Invocations
|
||||||
|
|
|
@ -1,6 +1,6 @@
|
||||||
# The Basics
|
# 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>
|
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"`.
|
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 — for example,
|
||||||
code libraries that define additional analysis rules.
|
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>
|
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".
|
The primary purpose of a run is to hold a set of "results".
|
||||||
A result is an observation about the code.
|
A result is an observation about the code.
|
||||||
For most tools, the results represent "issues" — conditions that might detract from the quality of the code.
|
For most tools, the results represent "issues" — conditions that might detract from the quality of the code.
|
Загрузка…
Ссылка в новой задаче