commit: 8e24f889cd79bbd20b1a67364330380cd1c43f78 Author: Anna Vyalkova <cyber+gentoo <AT> sysrq <DOT> in> AuthorDate: Wed Feb 23 08:23:35 2022 +0000 Commit: Michał Górny <mgorny <AT> gentoo <DOT> org> CommitDate: Wed Feb 23 15:45:07 2022 +0000 URL: https://gitweb.gentoo.org/proj/gentoo-syntax.git/commit/?id=8e24f889
README: add instructions for syntax checker Signed-off-by: Anna Vyalkova <cyber+gentoo <AT> sysrq.in> Closes: https://github.com/gentoo/gentoo-syntax/pull/45 Signed-off-by: Michał Górny <mgorny <AT> gentoo.org> README.rst | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/README.rst b/README.rst index 1df3161..6617aa4 100644 --- a/README.rst +++ b/README.rst @@ -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 ====
