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

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

diff --git a/.vim/bundle/ale/doc/ale-prolog.txt b/.vim/bundle/ale/doc/ale-prolog.txt
new file mode 100644 (file)
index 0000000..334ff72
--- /dev/null
+++ b/.vim/bundle/ale/doc/ale-prolog.txt
@@ -0,0 +1,71 @@
+===============================================================================
+ALE Prolog Integration                                     *ale-prolog-options*
+
+
+===============================================================================
+swipl                                                        *ale-prolog-swipl*
+
+                                          *ale-options.prolog_swipl_executable*
+                                                *g:ale_prolog_swipl_executable*
+                                                *b:ale_prolog_swipl_executable*
+prolog_swipl_executable
+g:ale_prolog_swipl_executable
+  Type: |String|
+  Default: `'swipl'`
+
+  The executable that will be run for the `swipl` linter.
+
+                                                *ale-options.prolog_swipl_load*
+                                                      *g:ale_prolog_swipl_load*
+                                                      *b:ale_prolog_swipl_load*
+prolog_swipl_load
+g:ale_prolog_swipl_load
+  Type: |String|
+  Default: `'current_prolog_flag(argv, [File]), load_files(File, [sandboxed(true)]), halt.'`
+
+  The prolog goals that will be passed to |g:ale_prolog_swipl_executable| with `-g` option.
+
+  It does:
+  1. Takes the first command argument (current file path)
+  2. Checks (syntactic / semantic) problems and output to stderr
+
+  NOTE: `sandboxed(true)` prohibits executing some directives such as 'initialization main'.
+
+                                             *ale-options.prolog_swipl_timeout*
+                                                   *g:ale_prolog_swipl_timeout*
+                                                   *b:ale_prolog_swipl_timeout*
+prolog_swipl_timeout
+g:ale_prolog_swipl_timeout
+  Type: |Number|
+  Default: `3`
+
+  Timeout seconds to detect long-running linter.
+  It is done by setting SIGALRM.
+  See |g:ale_prolog_swipl_alarm| and |g:ale_prolog_swipl_alarm_handler|.
+
+                                               *ale-options.prolog_swipl_alarm*
+                                                     *g:ale_prolog_swipl_alarm*
+                                                     *b:ale_prolog_swipl_alarm*
+prolog_swipl_alarm
+g:ale_prolog_swipl_alarm
+  Type: |String|
+  Default: `'alarm(%t, (%h), _, [])'`
+
+  The prolog goals to be expected to set SIGALRM.
+  `%t` is replaced by |g:ale_prolog_swipl_timeout|.
+  `%h` is replaced by |g:ale_prolog_swipl_alarm_handler|.
+
+                                       *ale-options.prolog_swipl_alarm_handler*
+                                             *g:ale_prolog_swipl_alarm_handler*
+                                             *b:ale_prolog_swipl_alarm_handler*
+prolog_swipl_alarm_handler
+g:ale_prolog_swipl_alarm_handler
+  Type: |String|
+  Default: `'writeln(user_error, "ERROR: Exceeded %t seconds, Please change g:prolog_swipl_timeout to modify the limit."), halt(1)'`
+
+  The prolog goals to be expected that will be run on SIGALRM.
+  `%t` is replaced by |g:ale_prolog_swipl_timeout|.
+
+
+===============================================================================
+  vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl: