Skip to content

Commit b25b8fc

Browse files
committed
docs(#2934): script tidying
1 parent cbf864e commit b25b8fc

3 files changed

Lines changed: 4 additions & 3 deletions

File tree

CONTRIBUTING.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,6 @@ Suppressions are permitted only in the following cases:
104104
- Backwards compatibility shims
105105
- neovim API metadata incorrect, awaiting upstream fix
106106
- classic class framework
107-
- `gen_vimdoc_config.lua` help generator as it requires neovim source
108107

109108
# Backwards Compatibility
110109

scripts/gen_vimdoc.sh

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ DIR_WORK="/tmp/nvim-tree-gen_vimdoc"
1919
DIR_NVIM_SRC_DEF="/tmp/src/neovim-stable"
2020

2121
if [ ! -f "${DIR_NVT}/scripts/gen_vimdoc.sh" ]; then
22-
echo "Must be run from nvim-tree root"
22+
echo "Must be run from nvim-tree root" 1>&2
2323
exit 1
2424
fi
2525

scripts/lintdoc.sh

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ DIR_NVT="${PWD}"
2222
DIR_NVIM_SRC_DEF="/tmp/src/neovim-stable"
2323

2424
if [ ! -f "${DIR_NVT}/scripts/lintdoc.sh" ]; then
25-
echo "Must be run from nvim-tree root"
25+
echo "Must be run from nvim-tree root" 1>&2
2626
exit 1
2727
fi
2828

@@ -38,6 +38,8 @@ if [ ! -d "${DIR_NVIM_SRC}" ]; then
3838
3939
Nvim source is required to run ${0}
4040
41+
The "make lintdoc" target will be executed, which needs to compile Nvim first.
42+
4143
Please:
4244
mkdir -p ${DIR_NVIM_SRC_DEF}
4345
curl -L 'https://github.com/neovim/neovim/archive/refs/tags/stable.tar.gz' | tar zx --directory $(dirname "${DIR_NVIM_SRC_DEF}")

0 commit comments

Comments
 (0)