Skip to content

Commit

Permalink
docs: misc (neovim#29719)
Browse files Browse the repository at this point in the history
Co-authored-by: Evgeni Chasnovski <evgeni.chasnovski@gmail.com>
Co-authored-by: Lauri Heiskanen <lauri.heiskanen@nimble.fi>
Co-authored-by: Piotr Doroszewski <5605596+Doroszewski@users.noreply.github.com>
Co-authored-by: Tobiasz Laskowski <tobil4sk@outlook.com>
Co-authored-by: ariel-lindemann <41641978+ariel-lindemann@users.noreply.github.com>
Co-authored-by: glepnir <glephunter@gmail.com>
Co-authored-by: zeertzjq <zeertzjq@outlook.com>
  • Loading branch information
8 people authored Aug 28, 2024
1 parent 3085c9d commit cd05a72
Show file tree
Hide file tree
Showing 15 changed files with 25 additions and 22 deletions.
4 changes: 2 additions & 2 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"

Expand All @@ -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/"

Expand Down
11 changes: 7 additions & 4 deletions MAINTAIN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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`
Expand Down
1 change: 1 addition & 0 deletions contrib/local.mk.example
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#
Expand Down
2 changes: 1 addition & 1 deletion runtime/doc/builtin.txt

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion runtime/doc/lsp.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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})'`.

Expand Down
2 changes: 1 addition & 1 deletion runtime/doc/lua.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 4 additions & 6 deletions runtime/doc/treesitter.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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|
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion runtime/lua/vim/_meta/vimfn.lua

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion runtime/lua/vim/filetype.lua
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion runtime/lua/vim/lsp.lua
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
1 change: 1 addition & 0 deletions runtime/nvim.desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion src/nvim/eval.lua
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
2 changes: 1 addition & 1 deletion src/nvim/memory.c
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion src/nvim/os/input.c
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion src/nvim/tui/tui.c
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down

0 comments on commit cd05a72

Please sign in to comment.