From 8a6b37bc51a353227b6711d3c1df12c2863e3302 Mon Sep 17 00:00:00 2001 From: Anna Henningsen Date: Wed, 16 Nov 2016 03:00:30 +0100 Subject: [PATCH] doc: remove backtick escaping for manpage refs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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 Reviewed-By: Jeremiah Senkpiel Reviewed-By: James M Snell Reviewed-By: Michaël Zasso Reviewed-By: Luigi Pinca --- doc/api/child_process.md | 2 +- doc/api/console.md | 4 ++-- doc/api/dns.md | 8 ++++---- doc/api/fs.md | 12 ++++++------ doc/api/readline.md | 4 ++-- doc/api/repl.md | 2 +- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/doc/api/child_process.md b/doc/api/child_process.md index e90f5286ab1eda..6c8861b3b2e192 100644 --- a/doc/api/child_process.md +++ b/doc/api/child_process.md @@ -824,7 +824,7 @@ added: v0.1.90 * `signal` {String} 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. ```js diff --git a/doc/api/console.md b/doc/api/console.md index 054eacc2bc7f82..e5d3957e5087dd 100644 --- a/doc/api/console.md +++ b/doc/api/console.md @@ -184,7 +184,7 @@ added: v0.1.100 Prints to `stderr` with newline. Multiple arguments can be passed, with the 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()`][]). ```js @@ -213,7 +213,7 @@ added: v0.1.100 Prints to `stdout` with newline. Multiple arguments can be passed, with the 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()`][]). ```js diff --git a/doc/api/dns.md b/doc/api/dns.md index 53af8491a7ef22..e253039b687ef0 100644 --- a/doc/api/dns.md +++ b/doc/api/dns.md @@ -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 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 -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 programs running on the same operating system_. 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 -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 operations) will experience degraded performance. In order to mitigate this 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()` 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 use libuv's threadpool. diff --git a/doc/api/fs.md b/doc/api/fs.md index 10170dbf893666..f799b869e65c53 100644 --- a/doc/api/fs.md +++ b/doc/api/fs.md @@ -251,13 +251,13 @@ page. The times in the stat object have the following semantics: * `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. - 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 - (inode data modification). Changed by the `chmod(2)`, `chown(2)`, - `link(2)`, `mknod(2)`, `rename(2)`, `unlink(2)`, `utimes(2)`, - `read(2)`, and `write(2)` system calls. + (inode data modification). Changed by the chmod(2), chown(2), + link(2), mknod(2), rename(2), unlink(2), utimes(2), + read(2), and write(2) system calls. * `birthtime` "Birth Time" - Time of file creation. Set once when the file is created. On filesystems where birthtime is not available, 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 and other FreeBSD variants, also set if the `atime` is explicitly 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 systems. Note that as of v0.12, `ctime` is not "creation time", and diff --git a/doc/api/readline.md b/doc/api/readline.md index fff79817335e3c..32fad5732c70df 100644 --- a/doc/api/readline.md +++ b/doc/api/readline.md @@ -124,7 +124,7 @@ added: v0.7.5 The `'SIGCONT'` event is emitted when a Node.js process previously moved into the background using `-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 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 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. The `'pause'` and `'SIGCONT'` events will not be emitted if the `input` was diff --git a/doc/api/repl.md b/doc/api/repl.md index 67eae5d1cca6e8..b78a13544add4a 100644 --- a/doc/api/repl.md +++ b/doc/api/repl.md @@ -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 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 [stream]: stream.html