diff options
| author |   Anna Vyalkova <cyber+gentoo@sysrq.in> | 2022-02-23 13:23:35 +0500 |
|---|---|---|
| committer |   Michał Górny <mgorny@gentoo.org> | 2022-02-23 16:45:07 +0100 |
| commit | 8e24f889cd79bbd20b1a67364330380cd1c43f78 (patch) | |
| tree | 068ec4f5d468906c9ceffb069539a4aca7f3b95b | |
| parent | README: add "License" section (diff) | |
| download | gentoo-syntax-8e24f889cd79bbd20b1a67364330380cd1c43f78.tar.gz gentoo-syntax-8e24f889cd79bbd20b1a67364330380cd1c43f78.tar.bz2 gentoo-syntax-8e24f889cd79bbd20b1a67364330380cd1c43f78.zip | |
README: add instructions for syntax checker
Signed-off-by: Anna Vyalkova <cyber+gentoo@sysrq.in>
Closes: https://github.com/gentoo/gentoo-syntax/pull/45
Signed-off-by: Michał Górny <mgorny@gentoo.org>
| -rw-r--r-- | README.rst | 18 |
1 files changed, 18 insertions, 0 deletions
@@ -11,6 +11,24 @@ Installing * Gentoo users: ``emerge app-vim/gentoo-syntax`` * Everyone else: ``make PREFIX=~/.vim/ install`` +This plugin also provides a syntax checker for ebuilds and eclasses. To enable +it, you need to install Syntastic_ and pkgcheck_ first:: + + # emerge app-vim/syntastic dev-util/pkgcheck + +Then you'll need to configure Syntastic (see ``:help syntastic-quickstart``) +and add the following line to your .vimrc file:: + + let g:syntastic_ebuild_checkers = ['pkgcheck'] + +To find non-POSIX code in OpenRC services, install ``dev-util/checkbashisms`` +and enable it for filetype "sh":: + + let g:syntastic_sh_checkers = ['sh', 'checkbashisms'] + +.. _Syntastic: https://github.com/vim-syntastic/syntastic +.. _pkgcheck: https://github.com/pkgcore/pkgcheck + Bugs ==== |