RepoMirrors/ale
1
0
Fork 0
mirror of https://github.com/dense-analysis/ale synced 2024-12-25 15:42:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge #66 with some amendments.

Browse Source
This commit is contained in:
Marc Delage 2016-10-09 21:13:33 +01:00 committed by w0rp
parent a1ecf9ecea
commit bc937639d0
1 changed files with 51 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

63
doc/ale.txt
View File

@ -6,17 +6,19 @@ ALE - Asychronous Lint Engine
===============================================================================
CONTENTS *ale-contents*
1. Introduction...................................|ale-introduction|
2. Supported Languages & Tools....................|ale-support|
3. Global Options.................................|ale-options|
4. Linter Specific Options........................|ale-linter-options|
4.1. eslint.....................................|ale-linter-options-eslint|
4.2. phpcs......................................|ale-linter-options-phpcs|
4.3. c-gcc......................................|ale-linter-options-c-gcc|
4.4. cpp-gcc....................................|ale-linter-options-cpp-gcc|
4.5. shell......................................|ale-linter-options-shell|
5. API............................................|ale-api|
6. Contact........................................|ale-contact|
1. Introduction...............................|ale-introduction|
2. Supported Languages & Tools................|ale-support|
3. Global Options.............................|ale-options|
4. Linter Specific Options....................|ale-linter-options|
4.1. eslint.................................|ale-linter-options-eslint|
4.2. phpcs..................................|ale-linter-options-phpcs|
4.3. c-gcc..................................|ale-linter-options-c-gcc|
4.4. cpp-gcc................................|ale-linter-options-cpp-gcc|
4.5. shell..................................|ale-linter-options-shell|
4.6. fortran-gcc............................|ale-linter-options-fortran-gcc|
4.7. html-tidy..............................|ale-linter-options-html-tidy|
5. API........................................|ale-api|
6. Contact....................................|ale-contact|
===============================================================================
1. Introduction *ale-introduction*
@ -301,6 +303,43 @@ read the shell from the shebang (`#!`) line from the shell script to
determine the shell program to run. When this detection fails, this variable
will be used instead.
-------------------------------------------------------------------------------
4.6. fortran-gcc *ale-linter-options-fortran-gcc*
g:ale_fortran_gcc_options *g:ale_fortran_gcc_options*
Type: |String|
Default: `'-Wall'`
This variable can be changed to modify flags given to gcc.
-------------------------------------------------------------------------------
4.7. html-tidy *ale-linter-options-html-tidy*
g:ale_html_tidy_executable *g:ale_html_tidy_executable*
Type: |String|
Default: `'tidy'`
This variable can be changed to change the path to tidy.
g:ale_html_tidy_args *g:ale_html_tidy_args*
Type: |String|
Default: `'-q -e -language en'`
This variable can be changed to change the arguments provided to the
executable.
ALE will attempt to automatically detect the appropriate file encoding to
provide to html-tidy, and fall back to UTF-8 when encoding detection fails.
The recognized file encodings are as follows:
ascii, big5, cp1252 (win1252), cp850 (ibm858), cp932 (shiftjis),
iso-2022-jp (iso-2022), latin1, macroman (mac), sjis (shiftjis), utf-16le,
utf-16, utf-8
===============================================================================
5. API *ale-api*
@ -388,7 +427,7 @@ ALEGetLinters(filetype) *ALEGetLinters()*
ALEGetStatusLine() *ALEGetStatusLine()*
Return a formatted string that can be added to the statusline.
The output's format is defined in |`g:ale_statusline_format`|.
The output's format is defined in |`g:ale_statusline_format`|.
To enable it, the following should be present in your |statusline| settings: >
%{ALEGetStatusLine()}