From 8f484f2e3a2f35de37e2aab18fee635095e48124 Mon Sep 17 00:00:00 2001 From: epriestley Date: Sun, 22 Nov 2015 15:18:19 -0800 Subject: [PATCH] Fix outdated lies in "Script and Regex" linter documentation Summary: See D14536. Some time ago, linters changed to no longer receive these special/unusual file types as inputs by default. Test Plan: - Read new docs. - Attempted to grep for other similar lies, although it's possible I missed some. I didn't find anything. Reviewers: bgamari, chad Reviewed By: chad Differential Revision: https://secure.phabricator.com/D14543 --- .../arcanist_lint_script_and_regex.diviner | 13 +++++-------- 1 file changed, 5 insertions(+), 8 deletions(-) diff --git a/src/docs/user/userguide/arcanist_lint_script_and_regex.diviner b/src/docs/user/userguide/arcanist_lint_script_and_regex.diviner index e8d021b1ac..fde32b7773 100644 --- a/src/docs/user/userguide/arcanist_lint_script_and_regex.diviner +++ b/src/docs/user/userguide/arcanist_lint_script_and_regex.diviner @@ -29,16 +29,13 @@ configure. == Script... == The script will be invoked once for each file that is to be linted, with -the file passed as the first argument. The file may begin with a "-"; ensure +the file passed as the first argument. The file may begin with a `-`; ensure your script will not interpret such files as flags (perhaps by ending your -script configuration with "--", if its argument parser supports that). +script configuration with `--`, if its argument parser supports that). -Note that when run via `arc diff`, the list of files to be linted includes -deleted files and files that were moved away by the change. The linter should -not assume the path it is given exists, and it is not an error for the -linter to be invoked with paths which are no longer there. (Every affected -path is subject to lint because some linters may raise errors in other files -when a file is removed, or raise an error about its removal.) +Note that when run via `arc diff`, the list of files to be linted does not +include binary files, symlinks, deleted files, or directories. These special +file types are not supported by this linter. The script should emit lint messages to stdout, which will be parsed with the provided regex.