From 11a03be674d34186f1ced9b9767a36d09c689159 Mon Sep 17 00:00:00 2001 From: Larry Golding Date: Tue, 15 Oct 2019 09:02:25 -0700 Subject: [PATCH] Insert "Results" section and rename files and directories. --- README.md | 23 ++++++++++--------- docs/{Introduction.md => 1-Introduction.md} | 0 docs/{Basics.md => 2-Basics.md} | 4 +++- .../simple-example.js | 0 .../simple-example.sarif | 0 .../{Basics => 2-Basics}/empty-log.sarif.json | 0 6 files changed, 15 insertions(+), 12 deletions(-) rename docs/{Introduction.md => 1-Introduction.md} (100%) rename docs/{Basics.md => 2-Basics.md} (97%) rename samples/{Introduction => 1-Introduction}/simple-example.js (100%) rename samples/{Introduction => 1-Introduction}/simple-example.sarif (100%) rename samples/{Basics => 2-Basics}/empty-log.sarif.json (100%) diff --git a/README.md b/README.md index 9bb6a93..1a4c1e9 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docs/Introduction.md b/docs/1-Introduction.md similarity index 100% rename from docs/Introduction.md rename to docs/1-Introduction.md diff --git a/docs/Basics.md b/docs/2-Basics.md similarity index 97% rename from docs/Basics.md rename to docs/2-Basics.md index bb07f3f..9a42dab 100644 --- a/docs/Basics.md +++ b/docs/2-Basics.md @@ -1,6 +1,6 @@ # The Basics -## Logs, runs, and results +## Logs and runs A SARIF log is a JSON file.1 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. SARIF defines the optional `tool.extensions` property to represent plugins.4 +## 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" — conditions that might detract from the quality of the code. diff --git a/samples/Introduction/simple-example.js b/samples/1-Introduction/simple-example.js similarity index 100% rename from samples/Introduction/simple-example.js rename to samples/1-Introduction/simple-example.js diff --git a/samples/Introduction/simple-example.sarif b/samples/1-Introduction/simple-example.sarif similarity index 100% rename from samples/Introduction/simple-example.sarif rename to samples/1-Introduction/simple-example.sarif diff --git a/samples/Basics/empty-log.sarif.json b/samples/2-Basics/empty-log.sarif.json similarity index 100% rename from samples/Basics/empty-log.sarif.json rename to samples/2-Basics/empty-log.sarif.json