Skip to content

Commit 39f0482

Browse files
committed
doc: remove backtick escaping for manpage refs
Removing backticks will make the doctool emit links to the man pages. PR-URL: #9632 Reviewed-By: Ben Noordhuis <[email protected]> Reviewed-By: Jeremiah Senkpiel <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Michaël Zasso <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
1 parent 29bf871 commit 39f0482

File tree

6 files changed

+16
-16
lines changed

6 files changed

+16
-16
lines changed

doc/api/child_process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -824,7 +824,7 @@ added: v0.1.90
824824
* `signal` {String}
825825

826826
The `child.kill()` methods sends a signal to the child process. If no argument
827-
is given, the process will be sent the `'SIGTERM'` signal. See `signal(7)` for
827+
is given, the process will be sent the `'SIGTERM'` signal. See signal(7) for
828828
a list of available signals.
829829

830830
```js

doc/api/console.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ added: v0.1.100
184184

185185
Prints to `stderr` with newline. Multiple arguments can be passed, with the
186186
first used as the primary message and all additional used as substitution
187-
values similar to `printf(3)` (the arguments are all passed to
187+
values similar to printf(3) (the arguments are all passed to
188188
[`util.format()`][]).
189189

190190
```js
@@ -213,7 +213,7 @@ added: v0.1.100
213213

214214
Prints to `stdout` with newline. Multiple arguments can be passed, with the
215215
first used as the primary message and all additional used as substitution
216-
values similar to `printf(3)` (the arguments are all passed to
216+
values similar to printf(3) (the arguments are all passed to
217217
[`util.format()`][]).
218218

219219
```js

doc/api/dns.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -407,14 +407,14 @@ Under the hood, [`dns.lookup()`][] uses the same operating system facilities
407407
as most other programs. For instance, [`dns.lookup()`][] will almost always
408408
resolve a given name the same way as the `ping` command. On most POSIX-like
409409
operating systems, the behavior of the [`dns.lookup()`][] function can be
410-
modified by changing settings in `nsswitch.conf(5)` and/or `resolv.conf(5)`,
410+
modified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),
411411
but note that changing these files will change the behavior of _all other
412412
programs running on the same operating system_.
413413

414414
Though the call to `dns.lookup()` will be asynchronous from JavaScript's
415-
perspective, it is implemented as a synchronous call to `getaddrinfo(3)` that
415+
perspective, it is implemented as a synchronous call to getaddrinfo(3) that
416416
runs on libuv's threadpool. Because libuv's threadpool has a fixed size, it
417-
means that if for whatever reason the call to `getaddrinfo(3)` takes a long
417+
means that if for whatever reason the call to getaddrinfo(3) takes a long
418418
time, other operations that could run on libuv's threadpool (such as filesystem
419419
operations) will experience degraded performance. In order to mitigate this
420420
issue, one potential solution is to increase the size of libuv's threadpool by
@@ -425,7 +425,7 @@ setting the `'UV_THREADPOOL_SIZE'` environment variable to a value greater than
425425
### `dns.resolve()`, `dns.resolve*()` and `dns.reverse()`
426426

427427
These functions are implemented quite differently than [`dns.lookup()`][]. They
428-
do not use `getaddrinfo(3)` and they _always_ perform a DNS query on the
428+
do not use getaddrinfo(3) and they _always_ perform a DNS query on the
429429
network. This network communication is always done asynchronously, and does not
430430
use libuv's threadpool.
431431

doc/api/fs.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -251,21 +251,21 @@ page.
251251
The times in the stat object have the following semantics:
252252

253253
* `atime` "Access Time" - Time when file data last accessed. Changed
254-
by the `mknod(2)`, `utimes(2)`, and `read(2)` system calls.
254+
by the mknod(2), utimes(2), and read(2) system calls.
255255
* `mtime` "Modified Time" - Time when file data last modified.
256-
Changed by the `mknod(2)`, `utimes(2)`, and `write(2)` system calls.
256+
Changed by the mknod(2), utimes(2), and write(2) system calls.
257257
* `ctime` "Change Time" - Time when file status was last changed
258-
(inode data modification). Changed by the `chmod(2)`, `chown(2)`,
259-
`link(2)`, `mknod(2)`, `rename(2)`, `unlink(2)`, `utimes(2)`,
260-
`read(2)`, and `write(2)` system calls.
258+
(inode data modification). Changed by the chmod(2), chown(2),
259+
link(2), mknod(2), rename(2), unlink(2), utimes(2),
260+
read(2), and write(2) system calls.
261261
* `birthtime` "Birth Time" - Time of file creation. Set once when the
262262
file is created. On filesystems where birthtime is not available,
263263
this field may instead hold either the `ctime` or
264264
`1970-01-01T00:00Z` (ie, unix epoch timestamp `0`). Note that this
265265
value may be greater than `atime` or `mtime` in this case. On Darwin
266266
and other FreeBSD variants, also set if the `atime` is explicitly
267267
set to an earlier value than the current `birthtime` using the
268-
`utimes(2)` system call.
268+
utimes(2) system call.
269269

270270
Prior to Node v0.12, the `ctime` held the `birthtime` on Windows
271271
systems. Note that as of v0.12, `ctime` is not "creation time", and

doc/api/readline.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ added: v0.7.5
124124

125125
The `'SIGCONT'` event is emitted when a Node.js process previously moved into
126126
the background using `<ctrl>-Z` (i.e. `SIGTSTP`) is then brought back to the
127-
foreground using `fg(1)`.
127+
foreground using fg(1).
128128

129129
If the `input` stream was paused *before* the `SIGTSTP` request, this event will
130130
not be emitted.
@@ -174,7 +174,7 @@ input, typically known as `SIGTSTP`. If there are no `SIGTSTP` event listeners
174174
registered when the `input` stream receives a `SIGTSTP`, the Node.js process
175175
will be sent to the background.
176176

177-
When the program is resumed using `fg(1)`, the `'pause'` and `SIGCONT` events
177+
When the program is resumed using fg(1), the `'pause'` and `SIGCONT` events
178178
will be emitted. These can be used to resume the `input` stream.
179179

180180
The `'pause'` and `'SIGCONT'` events will not be emitted if the `input` was

doc/api/repl.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ possible to connect to a long-running Node.js process without restarting it.
535535
For an example of running a "full-featured" (`terminal`) REPL over
536536
a `net.Server` and `net.Socket` instance, see: https://gist.github.com/2209310
537537

538-
For an example of running a REPL instance over `curl(1)`,
538+
For an example of running a REPL instance over curl(1),
539539
see: https://gist.github.com/2053342
540540

541541
[stream]: stream.html

0 commit comments

Comments
 (0)