aboutsummaryrefslogtreecommitdiff
path: root/man
diff options
context:
space:
mode:
authorTom Ryder <tom@sanctum.geek.nz>2017-10-30 18:22:51 +1300
committerTom Ryder <tom@sanctum.geek.nz>2017-10-30 18:24:39 +1300
commit1ab5ee6ef4b0b018b36b4b9712dcf1d90ddda4bf (patch)
tree72aa1361dbda172d4415aa3a1f246c857ac0179e /man
parentSwitch to VimL functions for whitespace stripper (diff)
downloaddotfiles-1ab5ee6ef4b0b018b36b4b9712dcf1d90ddda4bf.tar.gz
dotfiles-1ab5ee6ef4b0b018b36b4b9712dcf1d90ddda4bf.zip
Add a `lint-vim` target for linting Vim config
Since I know there's a usable tool for this now in vim-vint, I may as well make a target for my own convenience later. Updated the README.markdown documentation of the `lint-*` targets, restructuring the paragraph into a nested list for clarity. Also updated the `dotfiles(7)` manual page to reflect those changes.
Diffstat (limited to 'man')
-rw-r--r--man/man7/dotfiles.7df34
1 files changed, 30 insertions, 4 deletions
diff --git a/man/man7/dotfiles.7df b/man/man7/dotfiles.7df
index 6ddacd5d..91b4b841 100644
--- a/man/man7/dotfiles.7df
+++ b/man/man7/dotfiles.7df
@@ -921,10 +921,36 @@ with \f[C]make\ check\-bash\f[], \f[C]make\ check\-sh\f[], or
\f[C]bin\f[] and \f[C]games\f[].
There's no proper test suite for the actual functionality (yet).
.PP
-If you have ShellCheck (https://www.shellcheck.net/) and/or
-Perl::Critic (http://perlcritic.com/), there's a \f[C]lint\f[] target
-for the shell script files and Perl files respectively.
-The files don't need to pass that check to be installed.
+There are also optional \f[C]lint\f[] targets, if you have the
+appropriate tools available to run them:
+.IP \[bu] 2
+ShellCheck (https://www.shellcheck.net/):
+.RS 2
+.IP \[bu] 2
+\f[C]lint\-bash\f[]
+.IP \[bu] 2
+\f[C]lint\-bin\f[]
+.IP \[bu] 2
+\f[C]lint\-games\f[]
+.IP \[bu] 2
+\f[C]lint\-ksh\f[]
+.IP \[bu] 2
+\f[C]lint\-sh\f[]
+.IP \[bu] 2
+\f[C]lint\-xinit\f[]
+.RE
+.IP \[bu] 2
+Perl::Critic (https://perlcritic.com/):
+.RS 2
+.IP \[bu] 2
+\f[C]lint\-urxvt\f[]
+.RE
+.IP \[bu] 2
+Vint (https://github.com/Kuniwak/vint):
+.RS 2
+.IP \[bu] 2
+\f[C]lint\-vim\f[]
+.RE
.SS Known issues
.PP
See ISSUES.markdown.