summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorJason Tibbitts <tibbs@math.uh.edu>2017-04-19 17:40:58 -0500
committerw0rp <w0rp@users.noreply.github.com>2017-04-19 23:40:58 +0100
commit4eeb4783d33eafeeda88186c058b8517a21e82bc (patch)
treefdcc5433c021be2923785427055d2486832bbb15 /doc
parentd8dcc56af58d1545cf3a7a9f6160d8ba6ad39923 (diff)
downloadale-4eeb4783d33eafeeda88186c058b8517a21e82bc.zip
Add rpm spec file linter (rpmlint) (#486)
* Initial attempt at an rpmlint linter. * Add some basic documentation. * Play with indentation in the test file. * Another attempt to fix the rpmlint test. * Hopefully this does it.
Diffstat (limited to 'doc')
-rw-r--r--doc/ale-spec.txt28
-rw-r--r--doc/ale.txt3
2 files changed, 31 insertions, 0 deletions
diff --git a/doc/ale-spec.txt b/doc/ale-spec.txt
new file mode 100644
index 00000000..fc6be562
--- /dev/null
+++ b/doc/ale-spec.txt
@@ -0,0 +1,28 @@
+===============================================================================
+ALE RPM Spec Integration *ale-spec-options*
+
+
+-------------------------------------------------------------------------------
+rpmlint *ale-spec-rpmlint*
+
+g:ale_spec_rpmlint_executable *g:ale_spec_rpmlint_executable*
+
+ Type: |String|
+ Default: `'rpmlint'`
+
+ This variable sets executable used for rpmlint.
+
+
+g:ale_spec_rpmlint_options *g:ale_spec_rpmlint_options*
+
+ Type: |String|
+ Default: `''`
+
+ Set this to pass extra arguments to rpmlint.
+
+ For example, to instruct rpmlint to use a specific configuration file:
+
+ let g:ale_spec_rpmlint_options = '-f custom.cf'
+
+-------------------------------------------------------------------------------
+ vim:tw=78:ts=2:sts=2:sw=2:ft=help:norl:
diff --git a/doc/ale.txt b/doc/ale.txt
index 1e332993..d3044d7e 100644
--- a/doc/ale.txt
+++ b/doc/ale.txt
@@ -71,6 +71,8 @@ CONTENTS *ale-contents*
sh....................................|ale-sh-options|
shell...............................|ale-sh-shell|
shellcheck..........................|ale-sh-shellcheck|
+ spec..................................|ale-spec-options|
+ rpmlint.............................|ale-spec-rpmlint|
tex...................................|ale-tex-options|
chktex..............................|ale-tex-chktex|
lacheck.............................|ale-tex-lacheck|
@@ -151,6 +153,7 @@ The following languages and tools are supported.
* Puppet: 'puppet', 'puppet-lint'
* Python: 'flake8', 'mypy', 'pylint'
* reStructuredText: 'proselint'
+* RPM spec: 'spec'
* Rust: 'rustc' (see |ale-integration-rust|)
* Ruby: 'rubocop'
* SASS: 'sasslint', 'stylelint'