docs(#3088): unify help generation and lint into vimdoc.sh, generation uses nvim source build to execute#3260
Merged
alex-courtis merged 4 commits into3088-gen_vimdoc-api-3231-remove-api-requiresfrom Feb 3, 2026
Conversation
…n uses nvim source build to execute
…n uses nvim source build to execute
…n uses nvim source build to execute
alex-courtis
commented
Feb 3, 2026
| mkdir -p "${DIR_NVIM_SRC}" | ||
| curl -L "https://github.com/neovim/neovim/archive/refs/tags/${{ matrix.nvim_version }}.tar.gz" | tar zx --directory "${DIR_NVIM_SRC}/.." | ||
| cd "${DIR_NVIM_SRC}" | ||
| make doc |
Member
Author
There was a problem hiding this comment.
Ensure that doc is successful without our changes for easier diagnosis.
alex-courtis
commented
Feb 3, 2026
|
|
||
| set -e | ||
|
|
||
| if [ $# -ne 1 ] || [ "${1}" != "doc" ] && [ "${1}" != "lintdoc" ]; then |
Member
Author
There was a problem hiding this comment.
Using the nvim make targets.
…n uses nvim source build to execute
Collaborator
|
|
Member
Author
Many thanks! |
alex-courtis
changed the title
alex-courtis
merged commit 8f30a4a
into
3088-gen_vimdoc-api-3231-remove-api-requires
5 checks passed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Generate is failing for users: #3244 (comment)
Looks like I made two bad assumptions:
gen_vimdoc.luaruns#!/usr/bin/env -S nvim -lwhich is the system installed nvim, with possibly different compiled RTPs when versions are differentgen_vimdoc.luaandluacats_parser.luain thescriptsdirectory, which was moved togen/srcin 0.11.After tweaking, it does run with 0.10, however the results are a bit different: looks like a couple of bugs were fixed in the generator.
Conservative fix:
gen_vimdoc.luadirectly, use the nvimmake docto execute it, using the built executablescripts/vimdoc.sh