Skip to content

Commit add2a62

Browse files
committed
runtime/doc: fix broken links found by make html
1 parent ff18d3b commit add2a62

22 files changed

+65
-96
lines changed

runtime/doc/api.txt

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ Buffer update events *api-buffer-updates*
8585
API clients can "attach" to Nvim buffers to subscribe to buffer update events.
8686
This is similar to |TextChanged| but more powerful and granular.
8787

88-
Call |nvim_buf_attach| to receive these events on the channel:
88+
Call |nvim_buf_attach()| to receive these events on the channel:
8989

9090
*nvim_buf_lines_event*
9191
nvim_buf_lines_event[{buf}, {changedtick}, {firstline}, {lastline}, {linedata}, {more}]
@@ -150,7 +150,7 @@ nvim_buf_detach_event[{buf}] *nvim_buf_detach_event*
150150

151151
EXAMPLE ~
152152

153-
Calling |nvim_buf_attach| with send_buffer=true on an empty buffer, emits: >
153+
Calling |nvim_buf_attach()| with send_buffer=true on an empty buffer, emits: >
154154
nvim_buf_lines_event[{buf}, {changedtick}, 0, 0, [""], v:false]
155155
156156
User adds two lines to the buffer, emits: >
@@ -189,12 +189,11 @@ Another use case are plugins that show output in an append-only buffer, and
189189
want to add highlights to the outputs. Highlight data cannot be preserved
190190
on writing and loading a buffer to file, nor in undo/redo cycles.
191191

192-
Highlights are registered using the |nvim_buf_add_highlight| function, see the
193-
generated API documentation for details. If an external highlighter plugin is
194-
adding a large number of highlights in a batch, performance can be improved by
195-
calling |nvim_buf_add_highlight| as an asynchronous notification, after first
196-
(synchronously) reqesting a source id. Here is an example using wrapper
197-
functions in the python client:
192+
Highlights are registered using the |nvim_buf_add_highlight()| function. If an
193+
external highlighter plugin wants to add many highlights in a batch,
194+
performance can be improved by calling |nvim_buf_add_highlight()| as an
195+
asynchronous notification, after first (synchronously) reqesting a source id.
196+
Example using the Nvim python-client:
198197
>
199198
src = vim.new_highlight_source()
200199
@@ -207,10 +206,10 @@ functions in the python client:
207206
buf.clear_highlight(src)
208207
<
209208
If the highlights don't need to be deleted or updated, just pass -1 as
210-
src_id (this is the default in python). |nvim_buf_clear_highlight| can be used
211-
to clear highlights from a specific source, in a specific line range or the
212-
entire buffer by passing in the line range 0, -1 (the latter is the default
213-
in python as used above).
209+
src_id (this is the default in python). Use |nvim_buf_clear_highlight()| to
210+
clear highlights from a specific source, in a specific line range or the
211+
entire buffer by passing in the line range 0, -1 (the latter is the default in
212+
python as used above).
214213

215214
An example of calling the api from vimscript: >
216215
@@ -655,14 +654,14 @@ nvim_get_chan_info({chan}) *nvim_get_chan_info()*
655654
stderr of this Nvim instance "socket" TCP/IP socket or
656655
named pipe "job" job with communication over its stdio
657656

658-
"mode" how data received on the channel is interpreted "bytes" send and recieve raw bytes "terminal" a |terminal| instance interprets ASCII sequences "rpc" |RPC| communication on the channel is active "pty" Name of pseudoterminal, if one is used (optional). On a POSIX system, this will be a device path like /dev/pts/1. Even if the name is unknown, the key will still be present to indicate a pty is used. This is currently the case when using winpty on windows. "buffer" buffer with connected |terminal| instance (optional) "client" information about the client on the other end of the RPC channel, if it has added it using |nvim_set_client_info|. (optional)
657+
"mode" how data received on the channel is interpreted "bytes" send and recieve raw bytes "terminal" a |terminal| instance interprets ASCII sequences "rpc" |RPC| communication on the channel is active "pty" Name of pseudoterminal, if one is used (optional). On a POSIX system, this will be a device path like /dev/pts/1. Even if the name is unknown, the key will still be present to indicate a pty is used. This is currently the case when using winpty on windows. "buffer" buffer with connected |terminal| instance (optional) "client" information about the client on the other end of the RPC channel, if it has added it using |nvim_set_client_info()|. (optional)
659658

660659
nvim_list_chans() *nvim_list_chans()*
661660
Get information about all open channels.
662661

663662
Return: ~
664663
Array of Dictionaries, each describing a channel with the
665-
format specified at |nvim_get_chan_info|.
664+
format specified at |nvim_get_chan_info()|.
666665

667666
nvim_call_atomic({calls}) *nvim_call_atomic()*
668667
Calls many API methods atomically.

runtime/doc/autocmd.txt

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
VIM REFERENCE MANUAL by Bram Moolenaar
55

66

7-
Automatic commands *autocommand*
7+
Automatic commands *autocmd* *autocommand*
88

99
For a basic explanation, see section |40.3| in the user manual.
1010

@@ -494,14 +494,14 @@ ChanInfo State of channel changed, for instance the
494494
client of a RPC channel described itself.
495495
Sets these |v:event| keys:
496496
info
497-
See |nvim_get_chan_info| for the format of the
498-
info Dictionary.
497+
See |nvim_get_chan_info()| for the format of
498+
the info Dictionary.
499499
*ChanOpen*
500500
ChanOpen Just after a channel was opened.
501501
Sets these |v:event| keys:
502502
info
503-
See |nvim_get_chan_info| for the format of the
504-
info Dictionary.
503+
See |nvim_get_chan_info()| for the format of
504+
the info Dictionary.
505505
*CmdUndefined*
506506
CmdUndefined When a user command is used but it isn't
507507
defined. Useful for defining a command only

runtime/doc/cmdline.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
VIM REFERENCE MANUAL by Bram Moolenaar
55

66

7-
*Cmdline-mode* *Command-line-mode*
8-
Command-line mode *Cmdline* *Command-line* *mode-cmdline* *:*
7+
*Cmdline-mode* *Command-line-mode* *Cmdline*
8+
Command-line mode *cmdline* *Command-line* *mode-cmdline* *:*
99

1010
Command-line mode is used to enter Ex commands (":"), search patterns
1111
("/" and "?"), and filter commands ("!").

runtime/doc/diff.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66

77
*diff* *diff-mode*
8-
This file describes the |+diff| feature: Showing differences between two to
8+
This file describes the diff feature: Showing differences between two to
99
eight versions of the same file.
1010

1111
The basics are explained in section |08.7| of the user manual.

runtime/doc/editing.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1225,9 +1225,6 @@ working directory, which in turn takes precedence over the global
12251225
working directory. If a local working directory (tab or window) does not
12261226
exist, the next-higher scope in the hierarchy applies.
12271227

1228-
Commands for changing the working directory can be suffixed with a bang "!"
1229-
(e.g. |:cd!|) which is ignored, for compatibility with Vim.
1230-
12311228
*:cd* *E747* *E472*
12321229
:cd[!] On non-Unix systems: Print the current directory
12331230
name. On Unix systems: Change the current directory

runtime/doc/eval.txt

Lines changed: 9 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1528,7 +1528,7 @@ v:event Dictionary of event data for the current |autocommand|. Valid
15281528
KEY DESCRIPTION ~
15291529
abort Whether the event triggered during
15301530
an aborting condition (e.g. |c_Esc| or
1531-
|c_CTRL-c| for |CmdlineLeave|).
1531+
|c_CTRL-C| for |CmdlineLeave|).
15321532
cmdlevel Level of cmdline.
15331533
cmdtype Type of cmdline, |cmdline-char|.
15341534
cwd Current working directory.
@@ -3230,8 +3230,7 @@ executable({expr}) *executable()*
32303230
On Windows it only checks if the file exists and
32313231
is not a directory, not if it's really executable.
32323232
On Windows an executable in the same directory as Vim is
3233-
always found. Since this directory is added to $PATH it
3234-
should also work to execute it |win32-PATH|.
3233+
always found (it is added to $PATH at |startup|).
32353234
The result is a Number:
32363235
1 exists
32373236
0 does not exist
@@ -4809,7 +4808,7 @@ input({opts})
48094808
where
48104809
hl_start_col is the first highlighted column,
48114810
hl_end_col is the last highlighted column (+ 1!),
4812-
hl_group is |:hl| group used for highlighting.
4811+
hl_group is |:hi| group used for highlighting.
48134812
*E5403* *E5404* *E5405* *E5406*
48144813
Both hl_start_col and hl_end_col + 1 must point to the start
48154814
of the multibyte character (highlighting must not break
@@ -5014,7 +5013,7 @@ jobstart({cmd}[, {opts}]) *jobstart()*
50145013
was used) to send data to stdin and |chanclose()| to close stdio
50155014
streams without stopping the job explicitly.
50165015

5017-
See |job-control| and |rpc|.
5016+
See |job-control| and |RPC|.
50185017

50195018
NOTE: on Windows if {cmd} is a List:
50205019
- cmd[0] must be an executable (not a "built-in"). If it is
@@ -5056,7 +5055,7 @@ jobstart({cmd}[, {opts}]) *jobstart()*
50565055
- The channel ID on success
50575056
- 0 on invalid arguments
50585057
- -1 if {cmd}[0] is not executable.
5059-
See |job-control|, |channels|, and |msgpack-rpc| for more information.
5058+
See also |job-control|, |channel|, |msgpack-rpc|.
50605059

50615060
jobstop({id}) *jobstop()*
50625061
Stop |job-id| {id} by sending SIGTERM to the job process. If
@@ -6390,11 +6389,9 @@ rpcstart({prog}[, {argv}]) {Nvim} *rpcstart()*
63906389
:let id = jobstart(['prog', 'arg1', 'arg2'], {'rpc': v:true})
63916390
63926391
rpcstop({channel}) {Nvim} *rpcstop()*
6393-
Deprecated. This function was used to stop a job with |rpc|
6394-
channel, and additionally closed rpc sockets. Instead use
6395-
|jobstop()| to stop any job, and |chanclose|(id, "rpc") to close
6396-
rpc communication without stopping the job. Use |chanclose|(id)
6397-
to close any socket.
6392+
Deprecated. Instead use |jobstop()| to stop any job, and
6393+
chanclose(id, "rpc") to close RPC communication without
6394+
stopping the job. Use chanclose(id) to close any socket.
63986395

63996396
screenattr({row}, {col}) *screenattr()*
64006397
Like |screenchar()|, but return the attribute. This is a rather
@@ -8888,9 +8885,6 @@ Also note that if you have two script files, and one calls a function in the
88888885
other and vice versa, before the used function is defined, it won't work.
88898886
Avoid using the autoload functionality at the toplevel.
88908887

8891-
Hint: If you distribute a bunch of scripts you can pack them together with the
8892-
|vimball| utility. Also read the user manual |distribute-script|.
8893-
88948888
==============================================================================
88958889
6. Curly braces names *curly-braces-names*
88968890

@@ -10762,7 +10756,7 @@ Group Default link Colored expression ~
1076210756
|expr-entry|
1076310757

1076410758
*hl-NvimColon* Delimiter `:` in |dict| literal
10765-
*hl-NvimComma* Delimiter `,` in |dict|/|list|
10759+
*hl-NvimComma* Delimiter `,` in |dict| or |list|
1076610760
literal or
1076710761
|expr-function|
1076810762
*hl-NvimArrow* Delimiter `->` in |lambda|

runtime/doc/if_pyth.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
VIM REFERENCE MANUAL by Paul Moore
55

66

7-
The Python Interface to Vim *python* *Python*
7+
The Python Interface to Vim *if_pyth* *python* *Python*
88

99
See |provider-python| for more information. {Nvim}
1010

runtime/doc/if_ruby.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
VIM REFERENCE MANUAL by Shugo Maeda
55

6-
The Ruby Interface to Vim *ruby* *Ruby*
6+
The Ruby Interface to Vim *if_ruby* *ruby* *Ruby*
77

88
*E266* *E267* *E268* *E269* *E270* *E271* *E272* *E273*
99

runtime/doc/intro.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -439,7 +439,7 @@ notation meaning equivalent decimal value(s) ~
439439
<k0> - <k9> keypad 0 to 9 *keypad-0* *keypad-9*
440440
<S-...> shift-key *shift* *<S-*
441441
<C-...> control-key *control* *ctrl* *<C-*
442-
<M-...> alt-key or meta-key *META* *meta* *alt* *<M-*
442+
<M-...> alt-key or meta-key *META* *ALT* *<M-*
443443
<A-...> same as <M-...> *<A-*
444444
<D-...> command-key or "super" key *<D-*
445445
-----------------------------------------------------------------------

runtime/doc/msgpack_rpc.txt

Lines changed: 5 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -61,18 +61,15 @@ To get a formatted dump of the API using python (requires the `pyyaml` and
6161
3. Connecting *rpc-connecting*
6262

6363
See |channel-intro|, for various ways to open a channel. Most of the channel
64-
opening functions take an `rpc` key in the options dictionary, to enable rpc.
64+
opening functions take an `rpc` key in the options dictionary, to enable RPC.
6565

66-
Additionally, rpc channels can be opened by other processes connecting to
66+
Additionally, RPC channels can be opened by other processes connecting to
6767
TCP/IP sockets or named pipes listened to by nvim.
6868

69-
An rpc socket is automatically created with each instance. The socket
70-
location is stored in |v:servername|. By default this is a named pipe
71-
with an automatically generated address. See |XXX|.
72-
73-
To make Nvim listen on a TCP/IP socket instead, specify |--listen|: >
69+
Nvim creates a default RPC socket at |startup|, given by |v:servername|. To
70+
start with a TCP/IP socket instead, use |--listen| with a TCP-style address: >
7471
nvim --listen 127.0.0.1:6666
75-
<Also, more sockets and named pipes can be listened on using |serverstart()|.
72+
Additional sockets and named pipes can be started with |serverstart()|.
7673

7774
Note that localhost TCP sockets are generally less secure than named pipes,
7875
and can lead to vunerabilities like remote code execution.

0 commit comments

Comments
 (0)