FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: remove backtick escaping for manpage refs · nodejs/node@4f2e254 · GitHub

/ node Public

Commit 4f2e254

Browse files
addaleax
authored and
MylesBorins
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 <info@bnoordhuis.nl> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent fd6b305 commit 4f2e254

6 files changed

Lines changed: 15 additions & 15 deletions

File tree

‎doc/api/child_process.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -776,7 +776,7 @@ added: v0.1.90
776776
* `signal` {String}
777777

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

782782
```js

‎doc/api/console.md‎

Lines changed: 2 additions & 2 deletions
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‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -394,14 +394,14 @@ Under the hood, [`dns.lookup()`][] uses the same operating system facilities
394394
as most other programs. For instance, [`dns.lookup()`][] will almost always
395395
resolve a given name the same way as the `ping` command. On most POSIX-like
396396
operating systems, the behavior of the [`dns.lookup()`][] function can be
397-
modified by changing settings in `nsswitch.conf(5)` and/or `resolv.conf(5)`,
397+
modified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),
398398
but note that changing these files will change the behavior of _all other
399399
programs running on the same operating system_.
400400

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

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

‎doc/api/fs.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -212,21 +212,21 @@ page.
212212
The times in the stat object have the following semantics:
213213

214214
* `atime` "Access Time" - Time when file data last accessed. Changed
215-
by the `mknod(2)`, `utimes(2)`, and `read(2)` system calls.
215+
by the mknod(2), utimes(2), and read(2) system calls.
216216
* `mtime` "Modified Time" - Time when file data last modified.
217-
Changed by the `mknod(2)`, `utimes(2)`, and `write(2)` system calls.
217+
Changed by the mknod(2), utimes(2), and write(2) system calls.
218218
* `ctime` "Change Time" - Time when file status was last changed
219-
(inode data modification). Changed by the `chmod(2)`, `chown(2)`,
220-
`link(2)`, `mknod(2)`, `rename(2)`, `unlink(2)`, `utimes(2)`,
221-
`read(2)`, and `write(2)` system calls.
219+
(inode data modification). Changed by the chmod(2), chown(2),
220+
link(2), mknod(2), rename(2), unlink(2), utimes(2),
221+
read(2), and write(2) system calls.
222222
* `birthtime` "Birth Time" - Time of file creation. Set once when the
223223
file is created. On filesystems where birthtime is not available,
224224
this field may instead hold either the `ctime` or
225225
`1970-01-01T00:00Z` (ie, unix epoch timestamp `0`). Note that this
226226
value may be greater than `atime` or `mtime` in this case. On Darwin
227227
and other FreeBSD variants, also set if the `atime` is explicitly
228228
set to an earlier value than the current `birthtime` using the
229-
`utimes(2)` system call.
229+
utimes(2) system call.
230230

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

‎doc/api/readline.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -207,7 +207,7 @@ added: v0.7.5
207207
**This does not work on Windows.**
208208

209209
Emitted whenever the `input` stream is sent to the background with `^Z`,
210-
respectively known as `SIGTSTP`, and then continued with `fg(1)`. This event
210+
respectively known as `SIGTSTP`, and then continued with fg(1). This event
211211
only emits if the stream was not paused before sending the program to the
212212
background.
213213

‎doc/api/repl.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -359,7 +359,7 @@ connect to a long-running Node.js process without restarting it.
359359
For an example of running a "full-featured" (`terminal`) REPL over
360360
a `net.Server` and `net.Socket` instance, see: https://gist.github.com/2209310
361361

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

365365
[`readline.prompt`]: readline.html#readline_rl_prompt_preservecursor

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL