diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d434ad6872..346ee1b94e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -273,7 +273,7 @@ If you need to modify or debug the documentation flow, these are the main files: runtime/lua/vim/* => runtime/doc/lua.txt runtime/lua/vim/lsp/ => runtime/doc/lsp.txt src/nvim/api/* => runtime/doc/api.txt - src/nvim/eval.lua => runtime/doc/builtin.txt + src/nvim/eval.lua => runtime/doc/vimfn.txt src/nvim/options.lua => runtime/doc/options.txt ``` diff --git a/runtime/doc/eval.txt b/runtime/doc/vimeval.txt similarity index 99% rename from runtime/doc/eval.txt rename to runtime/doc/vimeval.txt index 60238bc90d..706ed89c1a 100644 --- a/runtime/doc/eval.txt +++ b/runtime/doc/vimeval.txt @@ -1,10 +1,10 @@ -*eval.txt* Nvim +*vimeval.txt* Nvim VIM REFERENCE MANUAL by Bram Moolenaar -Expression evaluation *vimscript* *expression* *expr* *E15* *eval* +Expression evaluation *vimscript* *expression* *expr* *E15* *eval* *eval.txt* Using expressions is introduced in chapter 41 of the user manual |usr_41.txt|. diff --git a/runtime/doc/builtin.txt b/runtime/doc/vimfn.txt similarity index 99% rename from runtime/doc/builtin.txt rename to runtime/doc/vimfn.txt index f994686092..32d898098d 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/vimfn.txt @@ -1,10 +1,10 @@ -*builtin.txt* Nvim +*vimfn.txt* Nvim NVIM REFERENCE MANUAL -Builtin functions *vimscript-functions* *builtin-functions* +Vimscript functions *vimscript-functions* *builtin-functions* *builtin.txt* For functions grouped by what they are used for see |function-list|. diff --git a/scripts/vim-patch.sh b/scripts/vim-patch.sh index b0ec225633..e9cf37eaa6 100755 --- a/scripts/vim-patch.sh +++ b/scripts/vim-patch.sh @@ -293,6 +293,10 @@ preprocess_patch() { LC_ALL=C sed -Ee 's/( [ab]\/src\/nvim)\/option\.h/\1\/option_vars.h/g' \ "$file" > "$file".tmp && mv "$file".tmp "$file" + # Rename runtime/doc/eval.txt to runtime/doc/vimeval.txt + LC_ALL=C sed -Ee 's/( [ab]\/runtime\/doc)\/eval\.txt/\1\/vimeval.txt/g' \ + "$file" > "$file".tmp && mv "$file".tmp "$file" + # Rename version*.txt to news.txt LC_ALL=C sed -Ee 's/( [ab]\/runtime\/doc)\/version[0-9]+\.txt/\1\/news.txt/g' \ "$file" > "$file".tmp && mv "$file".tmp "$file" diff --git a/src/gen/gen_eval_files.lua b/src/gen/gen_eval_files.lua index cfa4d096a3..221c7975f6 100755 --- a/src/gen/gen_eval_files.lua +++ b/src/gen/gen_eval_files.lua @@ -955,17 +955,17 @@ local CONFIG = { render = render_api_keyset_meta, }, { - path = 'runtime/doc/builtin.txt', + path = 'runtime/doc/vimfn.txt', funcs = get_eval_meta, render = render_eval_doc, header = { - '*builtin.txt* Nvim', + '*vimfn.txt* Nvim', '', '', '\t\t NVIM REFERENCE MANUAL', '', '', - 'Builtin functions\t\t*vimscript-functions* *builtin-functions*', + 'Vimscript functions\t*vimscript-functions* *builtin-functions* *builtin.txt*', '', 'For functions grouped by what they are used for see |function-list|.', '', diff --git a/src/gen/gen_help_html.lua b/src/gen/gen_help_html.lua index b8a60ef4db..8eb18237c2 100644 --- a/src/gen/gen_help_html.lua +++ b/src/gen/gen_help_html.lua @@ -94,7 +94,7 @@ local redirects = { -- TODO: These known invalid |links| require an update to the relevant docs. local exclude_invalid = { - ["'string'"] = 'eval.txt', + ["'string'"] = 'vimeval.txt', Query = 'treesitter.txt', matchit = 'vim_diff.txt', ['set!'] = 'treesitter.txt', diff --git a/src/nvim/CMakeLists.txt b/src/nvim/CMakeLists.txt index e59be46314..136f8689aa 100644 --- a/src/nvim/CMakeLists.txt +++ b/src/nvim/CMakeLists.txt @@ -981,7 +981,7 @@ add_target(doc-eval ${PROJECT_SOURCE_DIR}/src/nvim/eval.lua ${PROJECT_SOURCE_DIR}/src/nvim/options.lua ${PROJECT_SOURCE_DIR}/src/nvim/vvars.lua - ${NVIM_RUNTIME_DIR}/doc/builtin.txt + ${NVIM_RUNTIME_DIR}/doc/vimfn.txt ) add_custom_target(doc) diff --git a/test/old/testdir/test_help.vim b/test/old/testdir/test_help.vim index 770358a38a..b59210249d 100644 --- a/test/old/testdir/test_help.vim +++ b/test/old/testdir/test_help.vim @@ -76,7 +76,7 @@ endfunc func Test_help_expr() help expr-!~? - call assert_equal('eval.txt', expand('%:t')) + call assert_equal('vimeval.txt', expand('%:t')) close endfunc