aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordundargoc <33953936+dundargoc@users.noreply.github.com>2024-07-04 23:20:45 +0200
committerGitHub <noreply@github.com>2024-07-05 05:20:45 +0800
commit25c59d08c4df9952c606bbc96b7b26dca429bb9c (patch)
tree522eb59d6ddf057a371dc3728f0a9e17f9d5e87e
parent71c50edceb5e097fe4faf9278a5fb4d41a303455 (diff)
downloadrneovim-25c59d08c4df9952c606bbc96b7b26dca429bb9c.tar.gz
rneovim-25c59d08c4df9952c606bbc96b7b26dca429bb9c.tar.bz2
rneovim-25c59d08c4df9952c606bbc96b7b26dca429bb9c.zip
docs: misc (#29410)
Co-authored-by: Michael Härtl <haertl.mike@gmail.com> Co-authored-by: zeertzjq <zeertzjq@outlook.com>
-rw-r--r--BUILD.md4
-rw-r--r--runtime/doc/support.txt11
-rw-r--r--runtime/doc/usr_05.txt2
-rw-r--r--runtime/doc/usr_toc.txt8
-rw-r--r--runtime/doc/vim_diff.txt5
-rw-r--r--src/nvim/cmdexpand.c1
-rw-r--r--src/nvim/tui/tui.c2
7 files changed, 17 insertions, 16 deletions
diff --git a/BUILD.md b/BUILD.md
index 4c24cf9b45..599f02c414 100644
--- a/BUILD.md
+++ b/BUILD.md
@@ -240,7 +240,7 @@ cmake --build build
### How to build without "bundled" dependencies
1. Manually install the dependencies:
- - libuv libluv libvterm luajit lua-lpeg lua-mpack msgpack-c tree-sitter tree-sitter-bash tree-sitter-c tree-sitter-lua tree-sitter-markdown tree-sitter-python tree-sitter-query tree-sitter-vim tree-sitter-vimdoc unibilium
+ - libuv libluv libutf8proc libvterm luajit lua-lpeg lua-mpack msgpack-c tree-sitter tree-sitter-bash tree-sitter-c tree-sitter-lua tree-sitter-markdown tree-sitter-python tree-sitter-query tree-sitter-vim tree-sitter-vimdoc unibilium
2. Run CMake:
```sh
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
@@ -261,7 +261,7 @@ cmake --build build
```sh
sudo apt install luajit libluajit-5.1-dev lua-mpack lua-lpeg libunibilium-dev libmsgpack-dev
-cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo -DUSE_BUNDLED=OFF -DUSE_BUNDLED_LIBUV=ON -DUSE_BUNDLED_LUV=ON -DUSE_BUNDLED_LIBVTERM=ON -DUSE_BUNDLED_TS=ON
+cmake -S cmake.deps -B .deps -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo -DUSE_BUNDLED=OFF -DUSE_BUNDLED_LIBUV=ON -DUSE_BUNDLED_LUV=ON -DUSE_BUNDLED_LIBVTERM=ON -DUSE_BUNDLED_TS=ON -DUSE_BUNDLED_UTF8PROC=ON
cmake --build .deps
cmake -B build -G Ninja -D CMAKE_BUILD_TYPE=RelWithDebInfo
cmake --build build
diff --git a/runtime/doc/support.txt b/runtime/doc/support.txt
index 5b8b32fa16..3f9a358962 100644
--- a/runtime/doc/support.txt
+++ b/runtime/doc/support.txt
@@ -14,7 +14,7 @@ Supported platforms *supported-platforms*
`System` `Tier` `Versions` `Tested versions`
Linux 1 >= 2.6.32, glibc >= 2.12 Ubuntu 22.04
macOS (Intel) 1 >= 11 macOS 12
-macOS (M1) 2 >= 11 macOS 14
+macOS (M1) 1 >= 11 macOS 14
Windows 64-bit 1 >= Windows 10 Version 1809 Windows Server 2022
FreeBSD 1 >= 10 FreeBSD 13
OpenBSD 2 >= 7
@@ -28,10 +28,10 @@ your Windows version, run the "winver" command and look for "Version xxxx"
Support types ~
* Tier 1: Officially supported and tested with CI. Any contributed patch
- MUST NOT break such systems.
+ MUST NOT break support for such platforms.
-* Tier 2: Officially supported, but not necessarily tested with CI. These
- systems are maintained to the best of our ability, without being a top
+* Tier 2: Officially supported, but not necessarily tested with CI. Support
+ for these platforms are maintained by best effort, without being a top
priority.
* Tier 3: Not tested and no guarantees, and not all features may work.
@@ -47,7 +47,8 @@ Common
Some common notes when adding support for new platforms:
-Cmake is the only supported build system. The platform must be buildable with cmake.
+CMake is the only supported build system. Nvim must be buildable on the
+platform with CMake.
All functionality related to the new platform must be implemented in its own
file inside `src/nvim/os` unless it's already done in a common file, in which
diff --git a/runtime/doc/usr_05.txt b/runtime/doc/usr_05.txt
index aa7dd8d05c..1c936d5f9d 100644
--- a/runtime/doc/usr_05.txt
+++ b/runtime/doc/usr_05.txt
@@ -120,7 +120,7 @@ This switches on three very clever mechanisms:
*restore-cursor* *last-position-jump* >
augroup RestoreCursor
autocmd!
- autocmd BufRead * autocmd FileType <buffer> ++once
+ autocmd BufReadPre * autocmd FileType <buffer> ++once
\ let s:line = line("'\"")
\ | if s:line >= 1 && s:line <= line("$") && &filetype !~# 'commit'
\ && index(['xxd', 'gitrebase'], &filetype) == -1
diff --git a/runtime/doc/usr_toc.txt b/runtime/doc/usr_toc.txt
index dd0d5784f5..2e70c20675 100644
--- a/runtime/doc/usr_toc.txt
+++ b/runtime/doc/usr_toc.txt
@@ -7,7 +7,7 @@
==============================================================================
Overview
-Getting Started
+Getting Started ~
|usr_01.txt| About the manuals
|usr_02.txt| The first steps in Vim
|usr_03.txt| Moving around
@@ -21,7 +21,7 @@ Getting Started
|usr_11.txt| Recovering from a crash
|usr_12.txt| Clever tricks
-Editing Effectively
+Editing Effectively ~
|usr_20.txt| Typing command-line commands quickly
|usr_21.txt| Go away and come back
|usr_22.txt| Finding the file to edit
@@ -36,7 +36,7 @@ Editing Effectively
|usr_31.txt| Exploiting the GUI
|usr_32.txt| The undo tree
-Tuning Vim
+Tuning Vim ~
|usr_40.txt| Make new commands
|usr_41.txt| Write a Vim script
|usr_42.txt| Add new menus
@@ -45,7 +45,7 @@ Tuning Vim
|usr_45.txt| Select your language (locale)
-Reference manual
+Reference manual ~
|reference_toc| More detailed information for all commands
The user manual is online:
diff --git a/runtime/doc/vim_diff.txt b/runtime/doc/vim_diff.txt
index c1daf4a937..d7f955a654 100644
--- a/runtime/doc/vim_diff.txt
+++ b/runtime/doc/vim_diff.txt
@@ -341,8 +341,9 @@ string options work.
- 'guicursor' works in the terminal (TUI)
- 'inccommand' shows interactive results for |:substitute|-like commands
and |:command-preview| commands
-- 'jumpoptions' "view" tries to restore the |mark-view| when moving through
- "unload" removes unloaded buffer from the jumplist
+- 'jumpoptions'
+ - "view" tries to restore |mark-view| when moving through the jumplist.
+ - "unload" removes unloaded buffers from the jumplist.
- the |jumplist|, |changelist|, |alternate-file| or using |mark-motions|.
- 'laststatus' global statusline support
- 'mousescroll' amount to scroll by when scrolling with a mouse
diff --git a/src/nvim/cmdexpand.c b/src/nvim/cmdexpand.c
index d235617ae1..db27e464a8 100644
--- a/src/nvim/cmdexpand.c
+++ b/src/nvim/cmdexpand.c
@@ -289,7 +289,6 @@ int nextwild(expand_T *xp, int type, int options, bool escape)
p2 = ExpandOne(xp, p1, xstrnsave(&ccline->cmdbuff[i], xp->xp_pattern_len),
use_options, type);
xfree(p1);
-
// Longest match: make sure it is not shorter, happens with :help.
if (p2 != NULL && type == WILD_LONGEST) {
int j;
diff --git a/src/nvim/tui/tui.c b/src/nvim/tui/tui.c
index 57696b1839..67ada24cd7 100644
--- a/src/nvim/tui/tui.c
+++ b/src/nvim/tui/tui.c
@@ -1704,7 +1704,7 @@ void tui_guess_size(TUIData *tui)
int width = 0;
int height = 0;
- // 1 - try from a system call(ioctl/TIOCGWINSZ on unix)
+ // 1 - try from a system call (ioctl/TIOCGWINSZ on unix)
if (tui->out_isatty
&& !uv_tty_get_winsize(&tui->output_handle.tty, &width, &height)) {
goto end;