lukechilds
/
node
mirror of https://github.com/lukechilds/node.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
Browse Source

doc: remove backtick escaping for manpage refs 

Removing backticks will make the doctool emit links to the man pages.

PR-URL: https://github.com/nodejs/node/pull/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>
v6
Anna Henningsen 8 years ago
parent
79c382787f
commit
8a6b37bc51
No known key found for this signature in database GPG Key ID: D8B9F5AEAE84E4CF
6 changed files with 16 additions and 16 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 2
      doc/api/child_process.md
  2. 4
      doc/api/console.md
  3. 8
      doc/api/dns.md
  4. 12
      doc/api/fs.md
  5. 4
      doc/api/readline.md
  6. 2
      doc/api/repl.md

2
doc/api/child_process.md
View File

@ -824,7 +824,7 @@ added: v0.1.90
* `signal` {String} * `signal` {String}
The `child.kill()` methods sends a signal to the child process. If no argument The `child.kill()` methods sends a signal to the child process. If no argument
is given, the process will be sent the `'SIGTERM'` signal. See `signal(7)` for is given, the process will be sent the `'SIGTERM'` signal. See signal(7) for
a list of available signals. a list of available signals.
```js ```js

4
doc/api/console.md
View File

@ -184,7 +184,7 @@ added: v0.1.100
Prints to `stderr` with newline. Multiple arguments can be passed, with the Prints to `stderr` with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution first used as the primary message and all additional used as substitution
values similar to `printf(3)` (the arguments are all passed to values similar to printf(3) (the arguments are all passed to
[`util.format()`][]). [`util.format()`][]).
```js ```js
@ -213,7 +213,7 @@ added: v0.1.100
Prints to `stdout` with newline. Multiple arguments can be passed, with the Prints to `stdout` with newline. Multiple arguments can be passed, with the
first used as the primary message and all additional used as substitution first used as the primary message and all additional used as substitution
values similar to `printf(3)` (the arguments are all passed to values similar to printf(3) (the arguments are all passed to
[`util.format()`][]). [`util.format()`][]).
```js ```js

8
doc/api/dns.md
View File

@ -421,14 +421,14 @@ Under the hood, [`dns.lookup()`][] uses the same operating system facilities
as most other programs. For instance, [`dns.lookup()`][] will almost always as most other programs. For instance, [`dns.lookup()`][] will almost always
resolve a given name the same way as the `ping` command. On most POSIX-like resolve a given name the same way as the `ping` command. On most POSIX-like
operating systems, the behavior of the [`dns.lookup()`][] function can be operating systems, the behavior of the [`dns.lookup()`][] function can be
modified by changing settings in `nsswitch.conf(5)` and/or `resolv.conf(5)`, modified by changing settings in nsswitch.conf(5) and/or resolv.conf(5),
but note that changing these files will change the behavior of _all other but note that changing these files will change the behavior of _all other
programs running on the same operating system_. programs running on the same operating system_.
Though the call to `dns.lookup()` will be asynchronous from JavaScript's Though the call to `dns.lookup()` will be asynchronous from JavaScript's
perspective, it is implemented as a synchronous call to `getaddrinfo(3)` that perspective, it is implemented as a synchronous call to getaddrinfo(3) that
runs on libuv's threadpool. Because libuv's threadpool has a fixed size, it runs on libuv's threadpool. Because libuv's threadpool has a fixed size, it
means that if for whatever reason the call to `getaddrinfo(3)` takes a long means that if for whatever reason the call to getaddrinfo(3) takes a long
time, other operations that could run on libuv's threadpool (such as filesystem time, other operations that could run on libuv's threadpool (such as filesystem
operations) will experience degraded performance. In order to mitigate this operations) will experience degraded performance. In order to mitigate this
issue, one potential solution is to increase the size of libuv's threadpool by issue, one potential solution is to increase the size of libuv's threadpool by
@ -439,7 +439,7 @@ setting the `'UV_THREADPOOL_SIZE'` environment variable to a value greater than
### `dns.resolve()`, `dns.resolve*()` and `dns.reverse()` ### `dns.resolve()`, `dns.resolve*()` and `dns.reverse()`
These functions are implemented quite differently than [`dns.lookup()`][]. They These functions are implemented quite differently than [`dns.lookup()`][]. They
do not use `getaddrinfo(3)` and they _always_ perform a DNS query on the do not use getaddrinfo(3) and they _always_ perform a DNS query on the
network. This network communication is always done asynchronously, and does not network. This network communication is always done asynchronously, and does not
use libuv's threadpool. use libuv's threadpool.

12
doc/api/fs.md
View File

@ -251,13 +251,13 @@ page.
The times in the stat object have the following semantics: The times in the stat object have the following semantics:
* `atime` "Access Time" - Time when file data last accessed. Changed * `atime` "Access Time" - Time when file data last accessed. Changed
by the `mknod(2)`, `utimes(2)`, and `read(2)` system calls. by the mknod(2), utimes(2), and read(2) system calls.
* `mtime` "Modified Time" - Time when file data last modified. * `mtime` "Modified Time" - Time when file data last modified.
Changed by the `mknod(2)`, `utimes(2)`, and `write(2)` system calls. Changed by the mknod(2), utimes(2), and write(2) system calls.
* `ctime` "Change Time" - Time when file status was last changed * `ctime` "Change Time" - Time when file status was last changed
(inode data modification). Changed by the `chmod(2)`, `chown(2)`, (inode data modification). Changed by the chmod(2), chown(2),
`link(2)`, `mknod(2)`, `rename(2)`, `unlink(2)`, `utimes(2)`, link(2), mknod(2), rename(2), unlink(2), utimes(2),
`read(2)`, and `write(2)` system calls. read(2), and write(2) system calls.
* `birthtime` "Birth Time" - Time of file creation. Set once when the * `birthtime` "Birth Time" - Time of file creation. Set once when the
file is created. On filesystems where birthtime is not available, file is created. On filesystems where birthtime is not available,
this field may instead hold either the `ctime` or this field may instead hold either the `ctime` or
@ -265,7 +265,7 @@ The times in the stat object have the following semantics:
value may be greater than `atime` or `mtime` in this case. On Darwin value may be greater than `atime` or `mtime` in this case. On Darwin
and other FreeBSD variants, also set if the `atime` is explicitly and other FreeBSD variants, also set if the `atime` is explicitly
set to an earlier value than the current `birthtime` using the set to an earlier value than the current `birthtime` using the
`utimes(2)` system call. utimes(2) system call.
Prior to Node v0.12, the `ctime` held the `birthtime` on Windows Prior to Node v0.12, the `ctime` held the `birthtime` on Windows
systems. Note that as of v0.12, `ctime` is not "creation time", and systems. Note that as of v0.12, `ctime` is not "creation time", and

4
doc/api/readline.md
View File

@ -124,7 +124,7 @@ added: v0.7.5
The `'SIGCONT'` event is emitted when a Node.js process previously moved into The `'SIGCONT'` event is emitted when a Node.js process previously moved into
the background using `<ctrl>-Z` (i.e. `SIGTSTP`) is then brought back to the the background using `<ctrl>-Z` (i.e. `SIGTSTP`) is then brought back to the
foreground using `fg(1)`. foreground using fg(1).
If the `input` stream was paused *before* the `SIGTSTP` request, this event will If the `input` stream was paused *before* the `SIGTSTP` request, this event will
not be emitted. not be emitted.
@ -174,7 +174,7 @@ input, typically known as `SIGTSTP`. If there are no `SIGTSTP` event listeners
registered when the `input` stream receives a `SIGTSTP`, the Node.js process registered when the `input` stream receives a `SIGTSTP`, the Node.js process
will be sent to the background. will be sent to the background.
When the program is resumed using `fg(1)`, the `'pause'` and `SIGCONT` events When the program is resumed using fg(1), the `'pause'` and `SIGCONT` events
will be emitted. These can be used to resume the `input` stream. will be emitted. These can be used to resume the `input` stream.
The `'pause'` and `'SIGCONT'` events will not be emitted if the `input` was The `'pause'` and `'SIGCONT'` events will not be emitted if the `input` was

2
doc/api/repl.md
View File

@ -535,7 +535,7 @@ possible to connect to a long-running Node.js process without restarting it.
For an example of running a "full-featured" (`terminal`) REPL over For an example of running a "full-featured" (`terminal`) REPL over
a `net.Server` and `net.Socket` instance, see: https://gist.github.com/2209310 a `net.Server` and `net.Socket` instance, see: https://gist.github.com/2209310
For an example of running a REPL instance over `curl(1)`, For an example of running a REPL instance over curl(1),
see: https://gist.github.com/2053342 see: https://gist.github.com/2053342
[stream]: stream.html [stream]: stream.html

Write Preview
Loading…
Cancel
Save