summaryrefslogtreecommitdiff
path: root/doc/ale-perl.txt
diff options
context:
space:
mode:
Diffstat (limited to 'doc/ale-perl.txt')
-rw-r--r--doc/ale-perl.txt12
1 files changed, 12 insertions, 0 deletions
diff --git a/doc/ale-perl.txt b/doc/ale-perl.txt
index 414856bd..761c2735 100644
--- a/doc/ale-perl.txt
+++ b/doc/ale-perl.txt
@@ -3,6 +3,9 @@ ALE Perl Integration *ale-perl-options*
ALE offers a few ways to check Perl code. Checking code with `perl` is
disabled by default, as `perl` code cannot be checked without executing it.
+Specifically, we use the `-c` flag to see if `perl` code compiles. This does
+not execute all of the code in a file, but it does run `BEGIN` and `CHECK`
+blocks. See `perl --help` and https://stackoverflow.com/a/12908487/406224
See |g:ale_linters|.
@@ -73,7 +76,16 @@ g:ale_perl_perlcritic_showrules *g:ale_perl_perlcritic_showrules*
Controls whether perlcritic rule names are shown after the error message.
Defaults to off to reduce length of message.
+===============================================================================
+perltidy *ale-perl-perltidy*
+
+g:ale_perl_perltidy_options *g:ale_perl_perltidy_options*
+ *b:ale_perl_perltidy_options*
+ Type: |String|
+ Default: `''`
+ This variable can be changed to alter the command-line arguments to
+ the perltidy invocation.
===============================================================================
vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: