mirror of
https://github.com/neovim/neovim.git
synced 2025-02-25 18:55:25 -06:00
docs: small fixes (#27364)
Co-authored-by: C.D. MacEachern <craig.daniel.maceachern@gmail.com> Co-authored-by: Ynda Jas <yndajas@gmail.com> Co-authored-by: Owen Hines <TheOdd@users.noreply.github.com> Co-authored-by: Wanten <41904684+WantenMN@users.noreply.github.com> Co-authored-by: lukasvrenner <118417051+lukasvrenner@users.noreply.github.com> Co-authored-by: cuinix <915115094@qq.com>
This commit is contained in:
parent
ac8cd5368d
commit
a74e869ffa
2
BUILD.md
2
BUILD.md
@ -290,7 +290,7 @@ Platform-specific requirements are listed below.
|
|||||||
### Ubuntu / Debian
|
### Ubuntu / Debian
|
||||||
|
|
||||||
```sh
|
```sh
|
||||||
sudo apt-get install ninja-build gettext cmake unzip curl
|
sudo apt-get install ninja-build gettext cmake unzip curl build-essential
|
||||||
```
|
```
|
||||||
|
|
||||||
### CentOS / RHEL / Fedora
|
### CentOS / RHEL / Fedora
|
||||||
|
@ -212,7 +212,7 @@ https://github.com/neovim/neovim-backup
|
|||||||
* Runner versions:
|
* Runner versions:
|
||||||
* For special-purpose jobs where the runner version doesn't really matter,
|
* For special-purpose jobs where the runner version doesn't really matter,
|
||||||
prefer `-latest` tags so we don't need to manually bump the versions. An
|
prefer `-latest` tags so we don't need to manually bump the versions. An
|
||||||
example of a special-purpose workflow is `labeler.yml`.
|
example of a special-purpose workflow is `labeler_pr.yml`.
|
||||||
* For our testing jobs, which are in `test.yml` and `build.yml`, prefer to
|
* For our testing jobs, which are in `test.yml` and `build.yml`, prefer to
|
||||||
use the latest stable (i.e. non-beta) version explicitly. Avoid using the
|
use the latest stable (i.e. non-beta) version explicitly. Avoid using the
|
||||||
`-latest` tags here as it makes it difficult to determine from an
|
`-latest` tags here as it makes it difficult to determine from an
|
||||||
|
@ -699,7 +699,6 @@ tag char note action in Normal mode ~
|
|||||||
|
|
||||||
tag char note action in Normal mode ~
|
tag char note action in Normal mode ~
|
||||||
------------------------------------------------------------------------------ ~
|
------------------------------------------------------------------------------ ~
|
||||||
g_CTRL-A g CTRL-A dump a memory profile
|
|
||||||
|g_CTRL-G| g CTRL-G show information about current cursor
|
|g_CTRL-G| g CTRL-G show information about current cursor
|
||||||
position
|
position
|
||||||
|g_CTRL-H| g CTRL-H start Select block mode
|
|g_CTRL-H| g CTRL-H start Select block mode
|
||||||
|
@ -978,9 +978,9 @@ Lua module: vim.lsp.client *lsp-client*
|
|||||||
case-sensitive.
|
case-sensitive.
|
||||||
• {flags} (`table`) A table with flags for the client.
|
• {flags} (`table`) A table with flags for the client.
|
||||||
The current (experimental) flags are:
|
The current (experimental) flags are:
|
||||||
• {allow_incremental_sync}? (`boolean`) Allow
|
• {allow_incremental_sync}? (`boolean`,
|
||||||
using incremental sync for buffer edits
|
default: `true`) Allow using incremental
|
||||||
(defailt: `true`)
|
sync for buffer edits
|
||||||
• {debounce_text_changes} (`integer`, default:
|
• {debounce_text_changes} (`integer`, default:
|
||||||
`150`) Debounce `didChange` notifications to
|
`150`) Debounce `didChange` notifications to
|
||||||
the server by the given number in
|
the server by the given number in
|
||||||
@ -1149,9 +1149,9 @@ Lua module: vim.lsp.client *lsp-client*
|
|||||||
initialize request. Invalid/empty values will
|
initialize request. Invalid/empty values will
|
||||||
• {flags}? (`table`) A table with flags for the client. The
|
• {flags}? (`table`) A table with flags for the client. The
|
||||||
current (experimental) flags are:
|
current (experimental) flags are:
|
||||||
• {allow_incremental_sync}? (`boolean`) Allow
|
• {allow_incremental_sync}? (`boolean`, default:
|
||||||
using incremental sync for buffer edits
|
`true`) Allow using incremental sync for
|
||||||
(defailt: `true`)
|
buffer edits
|
||||||
• {debounce_text_changes} (`integer`, default:
|
• {debounce_text_changes} (`integer`, default:
|
||||||
`150`) Debounce `didChange` notifications to
|
`150`) Debounce `didChange` notifications to
|
||||||
the server by the given number in
|
the server by the given number in
|
||||||
@ -2096,7 +2096,7 @@ rename({old_fname}, {new_fname}, {opts}) *vim.lsp.util.rename()*
|
|||||||
It deletes existing buffers that conflict with the renamed file name only
|
It deletes existing buffers that conflict with the renamed file name only
|
||||||
when
|
when
|
||||||
• `opts` requests overwriting; or
|
• `opts` requests overwriting; or
|
||||||
• the conflicting buffers are not loaded, so that deleting thme does not
|
• the conflicting buffers are not loaded, so that deleting them does not
|
||||||
result in data loss.
|
result in data loss.
|
||||||
|
|
||||||
Parameters: ~
|
Parameters: ~
|
||||||
|
@ -932,7 +932,7 @@ implicit extra parameter `self`. Thus, the statement
|
|||||||
|
|
||||||
is syntactic sugar for
|
is syntactic sugar for
|
||||||
|
|
||||||
`t.a.b.c:f = function (self, (` `params` `)` `body` `end`
|
`t.a.b.c:f = function (` `self`, `params` `)` `body` `end`
|
||||||
|
|
||||||
==============================================================================
|
==============================================================================
|
||||||
2.6 Visibility Rules *lua-visibility*
|
2.6 Visibility Rules *lua-visibility*
|
||||||
|
@ -604,7 +604,7 @@ instead. Example: >
|
|||||||
map <Leader>A oanother line<Esc>
|
map <Leader>A oanother line<Esc>
|
||||||
Works like: >
|
Works like: >
|
||||||
map \A oanother line<Esc>
|
map \A oanother line<Esc>
|
||||||
But after:
|
But after: >
|
||||||
let mapleader = ","
|
let mapleader = ","
|
||||||
It works like: >
|
It works like: >
|
||||||
map ,A oanother line<Esc>
|
map ,A oanother line<Esc>
|
||||||
|
@ -80,6 +80,7 @@ Defaults *nvim-defaults*
|
|||||||
- 'tags' defaults to "./tags;,tags"
|
- 'tags' defaults to "./tags;,tags"
|
||||||
- 'termguicolors' is enabled by default if Nvim can detect support from the
|
- 'termguicolors' is enabled by default if Nvim can detect support from the
|
||||||
host terminal
|
host terminal
|
||||||
|
- 'ttimeout' is enabled
|
||||||
- 'ttimeoutlen' defaults to 50
|
- 'ttimeoutlen' defaults to 50
|
||||||
- 'ttyfast' is always set
|
- 'ttyfast' is always set
|
||||||
- 'undodir' defaults to ~/.local/state/nvim/undo// (|xdg|), auto-created
|
- 'undodir' defaults to ~/.local/state/nvim/undo// (|xdg|), auto-created
|
||||||
|
@ -17,7 +17,7 @@ local shell_error = function()
|
|||||||
return vim.v.shell_error ~= 0
|
return vim.v.shell_error ~= 0
|
||||||
end
|
end
|
||||||
|
|
||||||
local suggest_faq = 'https://github.com/neovim/neovim/blob/docs/install/BUILD.md#building'
|
local suggest_faq = 'https://github.com/neovim/neovim/blob/master/BUILD.md#building'
|
||||||
|
|
||||||
local function check_runtime()
|
local function check_runtime()
|
||||||
health.start('Runtime')
|
health.start('Runtime')
|
||||||
|
@ -15,7 +15,7 @@ local validate = vim.validate
|
|||||||
--- @inlinedoc
|
--- @inlinedoc
|
||||||
---
|
---
|
||||||
--- Allow using incremental sync for buffer edits
|
--- Allow using incremental sync for buffer edits
|
||||||
--- (defailt: `true`)
|
--- (default: `true`)
|
||||||
--- @field allow_incremental_sync? boolean
|
--- @field allow_incremental_sync? boolean
|
||||||
---
|
---
|
||||||
--- Debounce `didChange` notifications to the server by the given number in milliseconds.
|
--- Debounce `didChange` notifications to the server by the given number in milliseconds.
|
||||||
|
@ -690,7 +690,7 @@ end
|
|||||||
---
|
---
|
||||||
--- It deletes existing buffers that conflict with the renamed file name only when
|
--- It deletes existing buffers that conflict with the renamed file name only when
|
||||||
--- * `opts` requests overwriting; or
|
--- * `opts` requests overwriting; or
|
||||||
--- * the conflicting buffers are not loaded, so that deleting thme does not result in data loss.
|
--- * the conflicting buffers are not loaded, so that deleting them does not result in data loss.
|
||||||
---
|
---
|
||||||
--- @param old_fname string
|
--- @param old_fname string
|
||||||
--- @param new_fname string
|
--- @param new_fname string
|
||||||
|
@ -360,7 +360,7 @@ Fiix the errors oon thhis line and reeplace them witth undo.
|
|||||||
|
|
||||||
7. To undo previous actions, type: `u`{normal} (lowercase u)
|
7. To undo previous actions, type: `u`{normal} (lowercase u)
|
||||||
To undo all the changes on a line, type: `U`{normal} (capital U)
|
To undo all the changes on a line, type: `U`{normal} (capital U)
|
||||||
To undo the undo's, type: `<C-r>`{normal}
|
To undo the undos, type: `<C-r>`{normal}
|
||||||
|
|
||||||
# Lesson 3.1: THE PUT COMMAND
|
# Lesson 3.1: THE PUT COMMAND
|
||||||
|
|
||||||
@ -518,9 +518,9 @@ NOTE: When the search reaches the end of the file it will continue at the
|
|||||||
|
|
||||||
4. Type `%`{normal} to move the cursor to the other matching bracket.
|
4. Type `%`{normal} to move the cursor to the other matching bracket.
|
||||||
|
|
||||||
5. Move the cursor to another (,),[,],{ or } and see what `%`{normal} does.
|
5. Move the cursor to another (, ), [, ], {, or } and see what `%`{normal} does.
|
||||||
|
|
||||||
This ( is a test line with ('s, ['s ] and {'s } in it. ))
|
This ( is a test line with ('s, ['s, ] and {'s } in it. ))
|
||||||
|
|
||||||
NOTE: This is very useful in debugging a program with unmatched parentheses!
|
NOTE: This is very useful in debugging a program with unmatched parentheses!
|
||||||
|
|
||||||
@ -589,7 +589,7 @@ NOTE: You can also select the lines you want to substitute first using visual-mo
|
|||||||
~~~ cmd
|
~~~ cmd
|
||||||
:s/old/new
|
:s/old/new
|
||||||
~~~
|
~~~
|
||||||
To substitute new for all 'old's on a line type
|
To substitute new for all olds on a line type
|
||||||
~~~ cmd
|
~~~ cmd
|
||||||
:s/old/new/g
|
:s/old/new/g
|
||||||
~~~
|
~~~
|
||||||
@ -667,7 +667,7 @@ NOTE: If you were to exit Neovim and start it again with `nvim TEST`, the file
|
|||||||
|
|
||||||
4. Type
|
4. Type
|
||||||
|
|
||||||
`:w TEST`{vim}
|
`w TEST`{vim}
|
||||||
|
|
||||||
where TEST is a filename that does not exist yet. Verify that you see
|
where TEST is a filename that does not exist yet. Verify that you see
|
||||||
|
|
||||||
@ -762,7 +762,7 @@ Open up a line above this by typing O while the cursor is on this line.
|
|||||||
This li will allow you to pract appendi text to a line.
|
This li will allow you to pract appendi text to a line.
|
||||||
This line will allow you to practice appending text to a line.
|
This line will allow you to practice appending text to a line.
|
||||||
|
|
||||||
NOTE: [a](a), [i](i) and [A](A) all go to the same Insert mode, the only
|
NOTE: [a](a), [i](i), and [A](A) all go to the same Insert mode, the only
|
||||||
difference is where the characters are inserted.
|
difference is where the characters are inserted.
|
||||||
|
|
||||||
# Lesson 6.3: ANOTHER WAY TO REPLACE
|
# Lesson 6.3: ANOTHER WAY TO REPLACE
|
||||||
|
@ -1689,7 +1689,7 @@ def CheckSpacing(filename, clean_lines, linenum, error):
|
|||||||
|
|
||||||
# Look for < that is not surrounded by spaces. This is only
|
# Look for < that is not surrounded by spaces. This is only
|
||||||
# triggered if both sides are missing spaces, even though
|
# triggered if both sides are missing spaces, even though
|
||||||
# technically should should flag if at least one side is missing a
|
# technically should flag if at least one side is missing a
|
||||||
# space. This is done to avoid some false positives with shifts.
|
# space. This is done to avoid some false positives with shifts.
|
||||||
match = Search(r'[^\s<]<([^\s=<].*)', reduced_line)
|
match = Search(r'[^\s<]<([^\s=<].*)', reduced_line)
|
||||||
if (match and not FindNextMatchingAngleBracket(clean_lines, linenum,
|
if (match and not FindNextMatchingAngleBracket(clean_lines, linenum,
|
||||||
|
@ -259,7 +259,7 @@ put('version')
|
|||||||
fixdict(1 + #version)
|
fixdict(1 + #version)
|
||||||
for _, item in ipairs(version) do
|
for _, item in ipairs(version) do
|
||||||
-- NB: all items are mandatory. But any error will be less confusing
|
-- NB: all items are mandatory. But any error will be less confusing
|
||||||
-- with placholder vim.NIL (than invalid mpack data)
|
-- with placeholder vim.NIL (than invalid mpack data)
|
||||||
put(item[1], item[2] or vim.NIL)
|
put(item[1], item[2] or vim.NIL)
|
||||||
end
|
end
|
||||||
put('build', version_build)
|
put('build', version_build)
|
||||||
|
@ -460,7 +460,7 @@ static void meta_describe_key(uint32_t *meta_inc, MTKey k)
|
|||||||
meta_describe_key_inc(meta_inc, &k);
|
meta_describe_key_inc(meta_inc, &k);
|
||||||
}
|
}
|
||||||
|
|
||||||
// if x is internal, asumes x->meta[..] of children are correct
|
// if x is internal, assumes x->meta[..] of children are correct
|
||||||
static void meta_describe_node(uint32_t *meta_node, MTNode *x)
|
static void meta_describe_node(uint32_t *meta_node, MTNode *x)
|
||||||
{
|
{
|
||||||
memset(meta_node, 0, kMTMetaCount * sizeof(meta_node[0]));
|
memset(meta_node, 0, kMTMetaCount * sizeof(meta_node[0]));
|
||||||
@ -1425,7 +1425,7 @@ bool marktree_itr_get_ext(MarkTree *b, MTPos p, MarkTreeIter *itr, bool last, bo
|
|||||||
}
|
}
|
||||||
if (meta_filter) {
|
if (meta_filter) {
|
||||||
if (!meta_has(itr->x->meta[itr->i], meta_filter)) {
|
if (!meta_has(itr->x->meta[itr->i], meta_filter)) {
|
||||||
// this takes us to the interal position after the first rejected node
|
// this takes us to the internal position after the first rejected node
|
||||||
break;
|
break;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
@ -239,7 +239,7 @@ static void reset_skipcol(win_T *wp)
|
|||||||
redraw_later(wp, UPD_SOME_VALID);
|
redraw_later(wp, UPD_SOME_VALID);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Update curwin->w_topline to move the cursor onto the screen.
|
// Update wp->w_topline to move the cursor onto the screen.
|
||||||
void update_topline(win_T *wp)
|
void update_topline(win_T *wp)
|
||||||
{
|
{
|
||||||
bool check_botline = false;
|
bool check_botline = false;
|
||||||
@ -595,7 +595,7 @@ void changed_line_abv_curs_win(win_T *wp)
|
|||||||
|VALID_CHEIGHT|VALID_TOPLINE);
|
|VALID_CHEIGHT|VALID_TOPLINE);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Make sure the value of curwin->w_botline is valid.
|
// Make sure the value of wp->w_botline is valid.
|
||||||
void validate_botline(win_T *wp)
|
void validate_botline(win_T *wp)
|
||||||
{
|
{
|
||||||
if (!(wp->w_valid & VALID_BOTLINE)) {
|
if (!(wp->w_valid & VALID_BOTLINE)) {
|
||||||
|
Loading…
Reference in New Issue
Block a user