mirrors/neovim
1
0
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2025-09-17 16:58:17 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: various fixes (#27063)

Browse Source 
Co-authored-by: lmenou <menl94629@gmail.com>
Co-authored-by: altermo <107814000+altermo@users.noreply.github.com>
Co-authored-by: VanaIgr <vanaigranov@gmail.com>
Co-authored-by: Gregory Anders <greg@gpanders.com>
This commit is contained in:
dundargoc
2024-01-25 00:34:18 +01:00
committed by GitHub
parent 6ea6b3fee2
commit 76a659eb77
8 changed files with 34 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
INSTALL.md
View File

@@ -203,7 +203,6 @@ Neovim can be installed with:
sudo -H Compile NeoVim sudo -H Compile NeoVim
### Nix / NixOS ### Nix / NixOS
Neovim can be installed with: Neovim can be installed with:
@@ -252,9 +251,6 @@ Neovim is in [PLD Linux](https://github.com/pld-linux/neovim):
See [neovim on SlackBuilds](https://slackbuilds.org/apps/neovim/). See [neovim on SlackBuilds](https://slackbuilds.org/apps/neovim/).
For instructions on how to install the Python modules, see [`:help provider-python`].
### Source Mage ### Source Mage
Neovim can be installed using the Sorcery package manager: Neovim can be installed using the Sorcery package manager:
@@ -323,8 +319,6 @@ If you're using an older version Ubuntu you must use:
sudo apt-get install python3-setuptools sudo apt-get install python3-setuptools
sudo easy_install3 pip sudo easy_install3 pip
For instructions to install the Python modules, see [`:help provider-python`].
### Void-Linux ### Void-Linux
Neovim can be installed using the xbps package manager Neovim can be installed using the xbps package manager
@@ -397,7 +391,3 @@ Alternatively, just delete the `CMAKE_INSTALL_PREFIX` artifacts:
sudo rm /usr/local/bin/nvim sudo rm /usr/local/bin/nvim
sudo rm -r /usr/local/share/nvim/ sudo rm -r /usr/local/share/nvim/
``` ```
[`:help provider-python`]: https://neovim.io/doc/user/provider.html#provider-python

2
runtime/lua/vim/_meta/vimfn.lua generated
View File

@@ -9684,7 +9684,7 @@ function vim.fn.synIDtrans(synID) end
--- ---
--- @param lnum integer --- @param lnum integer
--- @param col integer --- @param col integer
--- @return {[1]: integer, [2]: string, [3]: integer}[] --- @return {[1]: integer, [2]: string, [3]: integer}
function vim.fn.synconcealed(lnum, col) end function vim.fn.synconcealed(lnum, col) end
--- Return a |List|, which is the stack of syntax items at the --- Return a |List|, which is the stack of syntax items at the

2
src/nvim/eval.lua
View File

@@ -11550,7 +11550,7 @@ M.funcs = {
]=], ]=],
name = 'synconcealed', name = 'synconcealed',
params = { { 'lnum', 'integer' }, { 'col', 'integer' } }, params = { { 'lnum', 'integer' }, { 'col', 'integer' } },
returns = '{[1]: integer, [2]: string, [3]: integer}[]', returns = '{[1]: integer, [2]: string, [3]: integer}',
signature = 'synconcealed({lnum}, {col})', signature = 'synconcealed({lnum}, {col})',
}, },
synstack = { synstack = {

2
src/nvim/ex_cmds.c
View File

@@ -3274,7 +3274,7 @@ static int check_regexp_delim(int c)
/// ///
/// @param cmdpreview_ns The namespace to show 'inccommand' preview highlights. /// @param cmdpreview_ns The namespace to show 'inccommand' preview highlights.
/// If <= 0, preview shouldn't be shown. /// If <= 0, preview shouldn't be shown.
/// @return 0, 1 or 2. See show_cmdpreview() for more information on what the return value means. /// @return 0, 1 or 2. See cmdpreview_may_show() for more information on the meaning.
static int do_sub(exarg_T *eap, const proftime_T timeout, const int cmdpreview_ns, static int do_sub(exarg_T *eap, const proftime_T timeout, const int cmdpreview_ns,
const handle_T cmdpreview_bufnr) const handle_T cmdpreview_bufnr)
{ {

3
src/nvim/highlight.c
View File

@@ -484,7 +484,7 @@ int hl_get_underline(void)
}); });
} }
/// Augment an existing attribute with the beginning or end of a URL hyperlink. /// Augment an existing attribute with a URL.
/// ///
/// @param attr Existing attribute to combine with /// @param attr Existing attribute to combine with
/// @param url The URL to associate with the highlight attribute /// @param url The URL to associate with the highlight attribute
@@ -646,7 +646,6 @@ int hl_combine_attr(int char_attr, int prim_attr)
} }
if ((new_en.url == -1) && (prim_aep.url >= 0)) { if ((new_en.url == -1) && (prim_aep.url >= 0)) {
// Combined attributes borrow the string from the primary attribute
new_en.url = prim_aep.url; new_en.url = prim_aep.url;
} }

41
src/nvim/plines.c
View File

@@ -35,14 +35,14 @@
/// Functions calculating horizontal size of text, when displayed in a window. /// Functions calculating horizontal size of text, when displayed in a window.
/// Return the number of characters 'c' will take on the screen, taking /// Return the number of cells the first char in "p" will take on the screen,
/// into account the size of a tab. /// taking into account the size of a tab.
/// Also see getvcol() /// Also see getvcol()
/// ///
/// @param p /// @param p
/// @param col /// @param col
/// ///
/// @return Number of characters. /// @return Number of cells.
int win_chartabsize(win_T *wp, char *p, colnr_T col) int win_chartabsize(win_T *wp, char *p, colnr_T col)
{ {
buf_T *buf = wp->w_buffer; buf_T *buf = wp->w_buffer;
@@ -57,7 +57,7 @@ int win_chartabsize(win_T *wp, char *p, colnr_T col)
/// @param startcol /// @param startcol
/// @param s /// @param s
/// ///
/// @return Number of characters the string will take on the screen. /// @return Number of cells the string will take on the screen.
int linetabsize_col(int startvcol, char *s) int linetabsize_col(int startvcol, char *s)
{ {
CharsizeArg csarg; CharsizeArg csarg;
@@ -107,14 +107,13 @@ CSType init_charsize_arg(CharsizeArg *csarg, win_T *wp, linenr_T lnum, char *lin
} }
} }
/// Get the number of characters taken up on the screen for the given cts and position. /// Get the number of cells taken up on the screen for the given arguments.
/// "cts->cur_text_width_left" and "cts->cur_text_width_right" are set /// "csarg->cur_text_width_left" and "csarg->cur_text_width_right" are set
/// to the extra size for inline virtual text. /// to the extra size for inline virtual text.
/// This function is used very often, keep it fast!!!!
/// ///
/// When "cts->max_head_vcol" is positive, only count in "head" the size /// When "csarg->max_head_vcol" is positive, only count in "head" the size
/// of 'showbreak'/'breakindent' before "cts->max_head_vcol". /// of 'showbreak'/'breakindent' before "csarg->max_head_vcol".
/// When "cts->max_head_vcol" is negative, only count in "head" the size /// When "csarg->max_head_vcol" is negative, only count in "head" the size
/// of 'showbreak'/'breakindent' before where cursor should be placed. /// of 'showbreak'/'breakindent' before where cursor should be placed.
CharSize charsize_regular(CharsizeArg *csarg, char *const cur, colnr_T const vcol, CharSize charsize_regular(CharsizeArg *csarg, char *const cur, colnr_T const vcol,
int32_t const cur_char) int32_t const cur_char)
@@ -326,8 +325,9 @@ CharSize charsize_regular(CharsizeArg *csarg, char *const cur, colnr_T const vco
return (CharSize){ .width = size, .head = head }; return (CharSize){ .width = size, .head = head };
} }
/// Like charsize_regular(), except it doesn't handle virtual text, /// Like charsize_regular(), except it doesn't handle inline virtual text,
/// linebreak, breakindent and showbreak. Handles normal characters, tabs and wrapping. /// 'linebreak', 'breakindent' or 'showbreak'.
/// Handles normal characters, tabs and wrapping.
/// This function is always inlined. /// This function is always inlined.
/// ///
/// @see charsize_regular /// @see charsize_regular
@@ -360,9 +360,12 @@ static inline CharSize charsize_fast_impl(win_T *const wp, bool use_tabstop, col
} }
} }
/// Like charsize_regular(), except it doesn't handle virtual text, /// Like charsize_regular(), except it doesn't handle inline virtual text,
/// linebreak, breakindent and showbreak. Handles normal characters, tabs and wrapping. /// 'linebreak', 'breakindent' or 'showbreak'.
/// Handles normal characters, tabs and wrapping.
/// Can be used if CSType is kCharsizeFast. /// Can be used if CSType is kCharsizeFast.
///
/// @see charsize_regular
CharSize charsize_fast(CharsizeArg *csarg, colnr_T const vcol, int32_t const cur_char) CharSize charsize_fast(CharsizeArg *csarg, colnr_T const vcol, int32_t const cur_char)
FUNC_ATTR_PURE FUNC_ATTR_PURE
{ {
@@ -397,14 +400,14 @@ static bool in_win_border(win_T *wp, colnr_T vcol)
return (vcol - width1) % width2 == width2 - 1; return (vcol - width1) % width2 == width2 - 1;
} }
/// Calculate virtual column until the given 'len'. /// Calculate virtual column until the given "len".
/// ///
/// @param arg Argument to charsize functions. /// @param arg Argument to charsize functions.
/// @param vcol Starting virtual column. /// @param vcol Starting virtual column.
/// @param len First byte of the end character, or MAXCOL. /// @param len First byte of the end character, or MAXCOL.
/// ///
/// @return virtual column before the character at 'len', /// @return virtual column before the character at "len",
/// or full size of the line if 'len' is MAXCOL. /// or full size of the line if "len" is MAXCOL.
int linesize_regular(CharsizeArg *const csarg, int vcol, colnr_T const len) int linesize_regular(CharsizeArg *const csarg, int vcol, colnr_T const len)
{ {
char *const line = csarg->line; char *const line = csarg->line;
@@ -424,9 +427,9 @@ int linesize_regular(CharsizeArg *const csarg, int vcol, colnr_T const len)
return vcol; return vcol;
} }
/// Like win_linesize_regular, but can be used when CStype is kCharsizeFast. /// Like linesize_regular(), but can be used when CStype is kCharsizeFast.
/// ///
/// @see win_linesize_regular /// @see linesize_regular
int linesize_fast(CharsizeArg const *const csarg, int vcol, colnr_T const len) int linesize_fast(CharsizeArg const *const csarg, int vcol, colnr_T const len)
{ {
win_T *const wp = csarg->win; win_T *const wp = csarg->win;

14
src/nvim/plines.h
View File

@@ -46,12 +46,12 @@ static inline CharSize win_charsize(CSType cstype, int vcol, char *ptr, int32_t
REAL_FATTR_NONNULL_ALL REAL_FATTR_WARN_UNUSED_RESULT REAL_FATTR_ALWAYS_INLINE; REAL_FATTR_NONNULL_ALL REAL_FATTR_WARN_UNUSED_RESULT REAL_FATTR_ALWAYS_INLINE;
/// Get the number of cells taken up on the screen by the given character at vcol. /// Get the number of cells taken up on the screen by the given character at vcol.
/// "arg->cur_text_width_left" and "arg->cur_text_width_right" are set /// "csarg->cur_text_width_left" and "csarg->cur_text_width_right" are set
/// to the extra size for inline virtual text. /// to the extra size for inline virtual text.
/// ///
/// When "arg->max_head_vcol" is positive, only count in "head" the size /// When "csarg->max_head_vcol" is positive, only count in "head" the size
/// of 'showbreak'/'breakindent' before "arg->max_head_vcol". /// of 'showbreak'/'breakindent' before "csarg->max_head_vcol".
/// When "arg->max_head_vcol" is negative, only count in "head" the size /// When "csarg->max_head_vcol" is negative, only count in "head" the size
/// of 'showbreak'/'breakindent' before where cursor should be placed. /// of 'showbreak'/'breakindent' before where cursor should be placed.
static inline CharSize win_charsize(CSType cstype, int vcol, char *ptr, int32_t chr, static inline CharSize win_charsize(CSType cstype, int vcol, char *ptr, int32_t chr,
CharsizeArg *csarg) CharsizeArg *csarg)
@@ -66,12 +66,12 @@ static inline CharSize win_charsize(CSType cstype, int vcol, char *ptr, int32_t
static inline int linetabsize_str(char *s) static inline int linetabsize_str(char *s)
REAL_FATTR_NONNULL_ALL REAL_FATTR_WARN_UNUSED_RESULT REAL_FATTR_ALWAYS_INLINE; REAL_FATTR_NONNULL_ALL REAL_FATTR_WARN_UNUSED_RESULT REAL_FATTR_ALWAYS_INLINE;
/// Return the number of characters the string 's' will take on the screen, /// Return the number of cells the string "s" will take on the screen,
/// taking into account the size of a tab. /// taking into account the size of a tab.
/// ///
/// @param s /// @param s
/// ///
/// @return Number of characters the string will take on the screen. /// @return Number of cells the string will take on the screen.
static inline int linetabsize_str(char *s) static inline int linetabsize_str(char *s)
{ {
return linetabsize_col(0, s); return linetabsize_col(0, s);
@@ -86,7 +86,7 @@ static inline int win_linetabsize(win_T *wp, linenr_T lnum, char *line, colnr_T
/// @param line /// @param line
/// @param len /// @param len
/// ///
/// @return Number of characters the string will take on the screen. /// @return Number of cells the string will take on the screen.
static inline int win_linetabsize(win_T *wp, linenr_T lnum, char *line, colnr_T len) static inline int win_linetabsize(win_T *wp, linenr_T lnum, char *line, colnr_T len)
{ {
CharsizeArg csarg; CharsizeArg csarg;

2
src/nvim/textformat.c
View File

@@ -81,7 +81,7 @@ void internal_format(int textwidth, int second_indent, int flags, bool format_on
bool do_comments = (flags & INSCHAR_DO_COM); bool do_comments = (flags & INSCHAR_DO_COM);
int has_lbr = curwin->w_p_lbr; int has_lbr = curwin->w_p_lbr;
// make sure win_lbr_chartabsize() counts correctly // make sure win_charsize() counts correctly
curwin->w_p_lbr = false; curwin->w_p_lbr = false;
// When 'ai' is off we don't want a space under the cursor to be // When 'ai' is off we don't want a space under the cursor to be