revi-archive/phorge-phorge
1
0
Fork 0
mirror of https://we.phorge.it/source/phorge.git synced 2024-12-25 06:50:55 +01:00
Code Issues Releases Wiki Activity

Fix outdated lies in "Script and Regex" linter documentation

Browse source 
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
This commit is contained in:
epriestley 2015-11-22 15:18:19 -08:00
parent b964f8873b
commit 8f484f2e3a
1 changed files with 5 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
src/docs/user/userguide/arcanist_lint_script_and_regex.diviner
View file

@ -29,16 +29,13 @@ configure.
== Script... == == Script... ==
The script will be invoked once for each file that is to be linted, with 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 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 Note that when run via `arc diff`, the list of files to be linted does not
deleted files and files that were moved away by the change. The linter should include binary files, symlinks, deleted files, or directories. These special
not assume the path it is given exists, and it is not an error for the file types are not supported by this linter.
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.)
The script should emit lint messages to stdout, which will be parsed with The script should emit lint messages to stdout, which will be parsed with
the provided regex. the provided regex.