From cd05a72fec49bfaa3911c141ac605b67b6e2270a Mon Sep 17 00:00:00 2001 From: dundargoc <33953936+dundargoc@users.noreply.github.com> Date: Thu, 29 Aug 2024 00:11:32 +0200 Subject: [PATCH] docs: misc (#29719) Co-authored-by: Evgeni Chasnovski Co-authored-by: Lauri Heiskanen Co-authored-by: Piotr Doroszewski <5605596+Doroszewski@users.noreply.github.com> Co-authored-by: Tobiasz Laskowski Co-authored-by: ariel-lindemann <41641978+ariel-lindemann@users.noreply.github.com> Co-authored-by: glepnir Co-authored-by: zeertzjq --- INSTALL.md | 4 ++-- MAINTAIN.md | 11 +++++++---- contrib/local.mk.example | 1 + runtime/doc/builtin.txt | 2 +- runtime/doc/lsp.txt | 2 +- runtime/doc/lua.txt | 2 +- runtime/doc/treesitter.txt | 10 ++++------ runtime/lua/vim/_meta/vimfn.lua | 2 +- runtime/lua/vim/filetype.lua | 2 +- runtime/lua/vim/lsp.lua | 2 +- runtime/nvim.desktop | 1 + src/nvim/eval.lua | 2 +- src/nvim/memory.c | 2 +- src/nvim/os/input.c | 2 +- src/nvim/tui/tui.c | 2 +- 15 files changed, 25 insertions(+), 22 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index af7580686b..509213fffc 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -112,7 +112,7 @@ sudo rm -rf /opt/nvim sudo tar -C /opt -xzf nvim-linux64.tar.gz ``` -Then add this to your shell config (`~/.bashrc`, `~/. zshrc`, ...): +Then add this to your shell config (`~/.bashrc`, `~/.zshrc`, ...): export PATH="$PATH:/opt/nvim-linux64/bin" @@ -129,7 +129,7 @@ To expose nvim globally: mkdir -p /opt/nvim mv nvim.appimage /opt/nvim/nvim -And the following line to your shell config (`~/.bashrc`, `~/. zshrc`, ...): +And the following line to your shell config (`~/.bashrc`, `~/.zshrc`, ...): export PATH="$PATH:/opt/nvim/" diff --git a/MAINTAIN.md b/MAINTAIN.md index 442fd996a6..4920074e36 100644 --- a/MAINTAIN.md +++ b/MAINTAIN.md @@ -170,6 +170,9 @@ Other dependencies * https://github.com/nvim-winget * Org secrets/tokens: * `CODECOV_TOKEN` + * `BACKPORT_KEY` +* Org/repo variables: + * `BACKPORT_APP` * Domain names (held in https://namecheap.com): * neovim.org * neovim.io @@ -185,10 +188,10 @@ Refactoring Refactoring Vim structurally and aesthetically is an important goal of Neovim. But there are some modules that should not be changed significantly, because -they are maintained Vim, at present. Until someone takes "ownership" of these -modules, the cost of any significant changes (including style or structural -changes that re-arrange the code) to these modules outweighs the benefit. The -modules are: +they are maintained by Vim, at present. Until someone takes "ownership" of +these modules, the cost of any significant changes (including style or +structural changes that re-arrange the code) to these modules outweighs the +benefit. The modules are: - `regexp.c` - `indent_c.c` diff --git a/contrib/local.mk.example b/contrib/local.mk.example index bdb889dfcd..718bf9f2a3 100644 --- a/contrib/local.mk.example +++ b/contrib/local.mk.example @@ -50,6 +50,7 @@ # DEPS_CMAKE_FLAGS += -DUSE_BUNDLED_TS=OFF # DEPS_CMAKE_FLAGS += -DUSE_BUNDLED_TS_PARSERS=OFF # DEPS_CMAKE_FLAGS += -DUSE_BUNDLED_UNIBILIUM=OFF +# DEPS_CMAKE_FLAGS += -DUSE_BUNDLED_UTF8PROC=OFF # # Or disable all bundled dependencies at once. # diff --git a/runtime/doc/builtin.txt b/runtime/doc/builtin.txt index 6d4003caa9..f1d8cc8526 100644 --- a/runtime/doc/builtin.txt +++ b/runtime/doc/builtin.txt @@ -1263,7 +1263,7 @@ executable({expr}) *executable()* On MS-Windows the ".exe", ".bat", etc. can optionally be included. Then the extensions in $PATHEXT are tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be found. If - $PATHEXT is not set then ".exe;.com;.bat;.cmd" is used. A dot + $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot by itself can be used in $PATHEXT to try using the name without an extension. When 'shell' looks like a Unix shell, then the name is also tried without adding an extension. diff --git a/runtime/doc/lsp.txt b/runtime/doc/lsp.txt index c6664215c3..7f5ae06030 100644 --- a/runtime/doc/lsp.txt +++ b/runtime/doc/lsp.txt @@ -765,7 +765,7 @@ formatexpr({opts}) *vim.lsp.formatexpr()* function. Currently only supports a single client. This can be set via - `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` but will typically or in + `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` or (more typically) in `on_attach` via `vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})'`. diff --git a/runtime/doc/lua.txt b/runtime/doc/lua.txt index 01535a4e41..f071d67030 100644 --- a/runtime/doc/lua.txt +++ b/runtime/doc/lua.txt @@ -2674,7 +2674,7 @@ vim.filetype.add({filetypes}) *vim.filetype.add()* ['.*/etc/foo/.*%.conf'] = { 'dosini', { priority = 10 } }, -- A pattern containing an environment variable ['${XDG_CONFIG_HOME}/foo/git'] = 'git', - ['README.(%a+)$'] = function(path, bufnr, ext) + ['.*README.(%a+)'] = function(path, bufnr, ext) if ext == 'md' then return 'markdown' elseif ext == 'rst' then diff --git a/runtime/doc/treesitter.txt b/runtime/doc/treesitter.txt index 50b2037af3..041adbf828 100644 --- a/runtime/doc/treesitter.txt +++ b/runtime/doc/treesitter.txt @@ -22,11 +22,9 @@ search for in the `parser` runtime directory. Nvim includes these parsers: -- Bash - C - Lua - Markdown -- Python - Vimscript - Vimdoc - Treesitter query files |ft-query-plugin| @@ -550,9 +548,9 @@ the exact definition): @keyword.coroutine keywords related to coroutines (e.g. `go` in Go, `async/await` in Python) @keyword.function keywords that define a function (e.g. `func` in Go, `def` in Python) @keyword.operator operators that are English words (e.g. `and`, `or`) -@keyword.import keywords for including modules (e.g. `import`, `from` in Python) -@keyword.type keywords defining composite types (e.g. `struct`, `enum`) -@keyword.modifier keywords defining type modifiers (e.g. `const`, `static`, `public`) +@keyword.import keywords for including or exporting modules (e.g. `import`, `from` in Python) +@keyword.type keywords describing namespaces and composite types (e.g. `struct`, `enum`) +@keyword.modifier keywords modifying other constructs (e.g. `const`, `static`, `public`) @keyword.repeat keywords related to loops (e.g. `for`, `while`) @keyword.return keywords like `return` and `yield` @keyword.debug keywords related to debugging @@ -608,7 +606,7 @@ the exact definition): @diff.delta changed text (for diff files) @tag XML-style tag names (e.g. in XML, HTML, etc.) -@tag.builtin XML-style tag names (e.g. HTML5 tags) +@tag.builtin builtin tag names (e.g. HTML5 tags) @tag.attribute XML-style tag attributes @tag.delimiter XML-style tag delimiters diff --git a/runtime/lua/vim/_meta/vimfn.lua b/runtime/lua/vim/_meta/vimfn.lua index 54ac60e272..a4a6df8633 100644 --- a/runtime/lua/vim/_meta/vimfn.lua +++ b/runtime/lua/vim/_meta/vimfn.lua @@ -1593,7 +1593,7 @@ function vim.fn.eventhandler() end --- On MS-Windows the ".exe", ".bat", etc. can optionally be --- included. Then the extensions in $PATHEXT are tried. Thus if --- "foo.exe" does not exist, "foo.exe.bat" can be found. If ---- $PATHEXT is not set then ".exe;.com;.bat;.cmd" is used. A dot +--- $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot --- by itself can be used in $PATHEXT to try using the name --- without an extension. When 'shell' looks like a Unix shell, --- then the name is also tried without adding an extension. diff --git a/runtime/lua/vim/filetype.lua b/runtime/lua/vim/filetype.lua index 71a49445de..d3c33c9564 100644 --- a/runtime/lua/vim/filetype.lua +++ b/runtime/lua/vim/filetype.lua @@ -2518,7 +2518,7 @@ end --- ['.*/etc/foo/.*%.conf'] = { 'dosini', { priority = 10 } }, --- -- A pattern containing an environment variable --- ['${XDG_CONFIG_HOME}/foo/git'] = 'git', ---- ['README.(%a+)$'] = function(path, bufnr, ext) +--- ['.*README.(%a+)'] = function(path, bufnr, ext) --- if ext == 'md' then --- return 'markdown' --- elseif ext == 'rst' then diff --git a/runtime/lua/vim/lsp.lua b/runtime/lua/vim/lsp.lua index 97f78d3009..60677554ce 100644 --- a/runtime/lua/vim/lsp.lua +++ b/runtime/lua/vim/lsp.lua @@ -1031,7 +1031,7 @@ end --- Provides an interface between the built-in client and a `formatexpr` function. --- --- Currently only supports a single client. This can be set via ---- `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` but will typically or in `on_attach` +--- `setlocal formatexpr=v:lua.vim.lsp.formatexpr()` or (more typically) in `on_attach` --- via `vim.bo[bufnr].formatexpr = 'v:lua.vim.lsp.formatexpr(#{timeout_ms:250})'`. --- ---@param opts? vim.lsp.formatexpr.Opts diff --git a/runtime/nvim.desktop b/runtime/nvim.desktop index 224353c6ad..f9feae926d 100644 --- a/runtime/nvim.desktop +++ b/runtime/nvim.desktop @@ -4,6 +4,7 @@ GenericName=Text Editor GenericName[ckb]=دەستکاریکەری دەق GenericName[de]=Texteditor GenericName[fr]=Éditeur de texte +GenericName[pl]=Edytor tekstu GenericName[ru]=Текстовый редактор GenericName[sr]=Едитор текст GenericName[tr]=Metin Düzenleyici diff --git a/src/nvim/eval.lua b/src/nvim/eval.lua index 228683065a..8deff7dd6b 100644 --- a/src/nvim/eval.lua +++ b/src/nvim/eval.lua @@ -2066,7 +2066,7 @@ M.funcs = { On MS-Windows the ".exe", ".bat", etc. can optionally be included. Then the extensions in $PATHEXT are tried. Thus if "foo.exe" does not exist, "foo.exe.bat" can be found. If - $PATHEXT is not set then ".exe;.com;.bat;.cmd" is used. A dot + $PATHEXT is not set then ".com;.exe;.bat;.cmd" is used. A dot by itself can be used in $PATHEXT to try using the name without an extension. When 'shell' looks like a Unix shell, then the name is also tried without adding an extension. diff --git a/src/nvim/memory.c b/src/nvim/memory.c index 50860c69d0..3aa37c047c 100644 --- a/src/nvim/memory.c +++ b/src/nvim/memory.c @@ -199,7 +199,7 @@ void *xmallocz(size_t size) { size_t total_size = size + 1; if (total_size < size) { - preserve_exit(_("Vim: Data too large to fit into virtual memory space\n")); + preserve_exit(_("Nvim: Data too large to fit into virtual memory space\n")); } void *ret = xmalloc(total_size); diff --git a/src/nvim/os/input.c b/src/nvim/os/input.c index ea21a32230..c4eb2803f6 100644 --- a/src/nvim/os/input.c +++ b/src/nvim/os/input.c @@ -564,7 +564,7 @@ static void read_error_exit(void) if (silent_mode) { // Normal way to exit for "nvim -es". getout(0); } - preserve_exit(_("Vim: Error reading input, exiting...\n")); + preserve_exit(_("Nvim: Error reading input, exiting...\n")); } static bool pending_events(MultiQueue *events) diff --git a/src/nvim/tui/tui.c b/src/nvim/tui/tui.c index d8b79fb193..1866a4a592 100644 --- a/src/nvim/tui/tui.c +++ b/src/nvim/tui/tui.c @@ -1038,7 +1038,7 @@ static void clear_region(TUIData *tui, int top, int bot, int left, int right, in // with the default colorscheme background. Consequently, any flush that happens // during startup would result in clearing invalidated regions with zeroed // clear_attrs, perceived as a black flicker. Reset attributes to clear with - // current terminal background instead(#28667, #28668). + // current terminal background instead (#28667, #28668). if (tui->set_default_colors) { update_attrs(tui, attr_id); } else {