Skip to content

Commit ace2c3b

Browse files
committed
Update derived files
1 parent 0c271e4 commit ace2c3b

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -582,7 +582,7 @@ Run a given linter on the lint information provided by the given targets.
582582

583583
| Field | Description |
584584
| ----- | ----------- |
585-
| `"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. |
585+
| `"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. |
586586
| `"config"` | Any configuration or other files needed by the linter. |
587587
| `"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}`. |
588588

0 commit comments

Comments
 (0)