diff options
| -rw-r--r-- | rules/lint/RULES | 20 |
1 files changed, 10 insertions, 10 deletions
diff --git a/rules/lint/RULES b/rules/lint/RULES index 1d25102..fef578a 100644 --- a/rules/lint/RULES +++ b/rules/lint/RULES @@ -55,16 +55,16 @@ { "linter": [ "Single artifact running the lint checks." , "" - , "This artifact with" + , "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\"." + , " by the field \"config\", and" , "- OUT pointing to a directory to which files with the lint result" , " can be written." - , "The linter is supposed to indicate by the exit code whether the" - , "indicated file complies with the given linting policy, with 0 meaning" + , "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." @@ -72,14 +72,14 @@ , "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 with names" - , "consisting entirely of digits are the results of the individual lint" + , "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" + , " - 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" + , " - 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" |