summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorKlaus Aehlig <klaus.aehlig@huawei.com>2024-10-31 14:04:42 +0100
committerKlaus Aehlig <klaus.aehlig@huawei.com>2024-10-31 14:04:42 +0100
commitace2c3b4bce01b0c3e4947f06df44b34f7b94a1e (patch)
tree4975aefab35a22f41d16a1f4ece423d72656d30b
parent0c271e486b10a3921845517dc6c839554b6e0aaf (diff)
downloadrules-cc-1.4.0.tar.gz
Update derived filesv1.4.0
-rw-r--r--README.md2
1 files changed, 1 insertions, 1 deletions
diff --git a/README.md b/README.md
index 8814784..d1274b4 100644
--- a/README.md
+++ b/README.md
@@ -582,7 +582,7 @@ Run a given linter on the lint information provided by the given targets.
| Field | Description |
| ----- | ----------- |
-| `"linter"` | Single artifact running the lint checks. This program is invoked with - argv`[1]` the file to lint, and - argv`[2:]` the original command line. This invocation happens in an environment with - CONFIG pointing to the directory with all the artifacts given by the field `"config"`, and - OUT pointing to a directory to which files with the lint result can be written. - META pointing to a json file contaning - at key `"direct deps artifact names"` a list of all input artifacts that come from the target itself or are runfiles of a direct dependency. It is supposed to indicate by the exit code whether the file to lint complies with the given linting policy, with 0 meaning compliant. Stdout and stderr, as well as the directory $`{OUT}` can be used to provide additional information. |
+| `"linter"` | Single artifact running the lint checks. This program is invoked with - argv`[1]` the file to lint, and - argv`[2:]` the original command line. This invocation happens in an environment with - CONFIG pointing to the directory with all the artifacts given by the field `"config"`, and - OUT pointing to a directory to which files with the lint result can be written. - META pointing to a json file contaning - at key `"direct deps artifact names"` a list of all input artifacts that come from the target itself or are runfiles of a direct dependency. - TMPDIR pointing to a directory location that can be used to create additional temporary files. It is supposed to indicate by the exit code whether the file to lint complies with the given linting policy, with 0 meaning compliant. Stdout and stderr, as well as the directory $`{OUT}` can be used to provide additional information. |
| `"config"` | Any configuration or other files needed by the linter. |
| `"summarizer"` | Single artifact generating a summary of the individual lint results. It will be called in a directory where all subdirectories except . and .. represent the results of the individual lint actions. Those are given as - a file `"result"` with content `"PASS"` if and only if the lint action exited 0, - files `"stdout"` and `"stderr"` with stdout and stderr of the lint action, and - a directory `"out"` with the additional information provided by the lint action. The summarizer is required to indicate the overall result by the exit code, produce a human-readable summary on stdout, and optionally additional information in the directory $`{OUT}`. |