Merge commit '76265755a1add77121c8f9dabb3e9bb70fe9a972' as '.vim/bundle/ale'

[etc/vim.git] / .vim / bundle / ale / doc / ale-perl.txt

diff --git a/.vim/bundle/ale/doc/ale-perl.txt b/.vim/bundle/ale/doc/ale-perl.txt
new file mode 100644 (file)
index 0000000..0f7553c
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-perl.txt
@@ -0,0 +1,110 @@
+===============================================================================
+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|.
+
+
+===============================================================================
+perl                                                            *ale-perl-perl*
+
+                                             *ale-options.perl_perl_executable*
+                                                   *g:ale_perl_perl_executable*
+                                                   *b:ale_perl_perl_executable*
+perl_perl_executable
+g:ale_perl_perl_executable
+  Type: |String|
+  Default: `'perl'`
+
+  This variable can be changed to modify the executable used for linting perl.
+
+                                                *ale-options.perl_perl_options*
+                                                      *g:ale_perl_perl_options*
+                                                      *b:ale_perl_perl_options*
+perl_perl_options
+g:ale_perl_perl_options
+  Type: |String|
+  Default: `'-c -Mwarnings -Ilib'`
+
+  This variable can be changed to alter the command-line arguments to the perl
+  invocation.
+
+
+===============================================================================
+perlcritic                                                *ale-perl-perlcritic*
+
+                                       *ale-options.perl_perlcritic_executable*
+                                             *g:ale_perl_perlcritic_executable*
+                                             *b:ale_perl_perlcritic_executable*
+perl_perlcritic_executable
+g:ale_perl_perlcritic_executable
+  Type: |String|
+  Default: `'perlcritic'`
+
+  This variable can be changed to modify the perlcritic executable used for
+  linting perl.
+
+                                          *ale-options.perl_perlcritic_profile*
+                                                *g:ale_perl_perlcritic_profile*
+                                                *b:ale_perl_perlcritic_profile*
+perl_perlcritic_profile
+g:ale_perl_perlcritic_profile
+  Type: |String|
+  Default: `'.perlcriticrc'`
+
+  This variable can be changed to modify the perlcritic profile used for
+  linting perl.  The current directory is checked for the file, then the
+  parent directory, etc, until it finds one.  If no matching file is found, no
+  profile is passed to perlcritic.
+
+  Set to an empty string to disable passing a specific profile to perlcritic
+  with the `'--profile'` option.
+
+  To prevent perlcritic from using any profile, set this variable to an empty
+  string and pass `'--no-profile'`to perlcritic via the
+  |g:ale_perl_perlcritic_options| variable.
+
+                                          *ale-options.perl_perlcritic_options*
+                                                *g:ale_perl_perlcritic_options*
+                                                *b:ale_perl_perlcritic_options*
+perl_perlcritic_options
+g:ale_perl_perlcritic_options
+  Type: |String|
+  Default: `''`
+
+  This variable can be changed to supply additional command-line arguments to
+  the perlcritic invocation.
+
+                                        *ale-options.perl_perlcritic_showrules*
+                                              *g:ale_perl_perlcritic_showrules*
+perl_perlcritic_showrules
+g:ale_perl_perlcritic_showrules
+  Type: |Number|
+  Default: `0`
+
+  Controls whether perlcritic rule names are shown after the error message.
+  Defaults to off to reduce length of message.
+
+
+===============================================================================
+perltidy                                                    *ale-perl-perltidy*
+
+                                            *ale-options.perl_perltidy_options*
+                                                  *g:ale_perl_perltidy_options*
+                                                  *b:ale_perl_perltidy_options*
+perl_perltidy_options
+g: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: