Skip to content

Commit

Permalink
doc: fix misplaced entries in test/common doc
Browse files Browse the repository at this point in the history
One entry is placed in the wrong module and other entries are not in
alphabetical order.

PR-URL: #20117
Reviewed-By: Trivikram Kamat <[email protected]>
Reviewed-By: Vse Mozhet Byt <[email protected]>
Reviewed-By: Richard Lau <[email protected]>
Reviewed-By: Colin Ihrig <[email protected]>
Reviewed-By: Beth Griggs <[email protected]>
  • Loading branch information
Trott authored and jasnell committed Apr 19, 2018
1 parent 1fab8b4 commit c31f0d0
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions test/common/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,9 +119,6 @@ Tests whether `name`, `expected`, and `code` are part of a raised warning. If
an expected warning does not have a code then `common.noWarnCode` can be used
to indicate this.

### noWarnCode
See `common.expectWarning()` for usage.

### fileExists(pathname)
* pathname [&lt;string>]
* return [&lt;boolean>]
Expand All @@ -147,13 +144,11 @@ consisting of all `ArrayBufferView` and an `ArrayBuffer`.

Returns the file name and line number for the provided Function.

### runWithInvalidFD(func)
* `func` [&lt;Function>]
### getTTYfd()

Runs `func` with an invalid file descriptor that is an unsigned integer and
can be used to trigger `EBADF` as the first argument. If no such file
descriptor could be generated, a skip message will be printed and the `func`
will not be run.
Attempts to get a valid TTY file descriptor. Returns `-1` if it fails.

The TTY file descriptor is assumed to be capable of being writable.

### globalCheck
* [&lt;boolean>]
Expand Down Expand Up @@ -328,6 +323,9 @@ Returns `true` if the exit code `exitCode` and/or signal name `signal` represent
the exit code and/or signal name of a node process that aborted, `false`
otherwise.

### noWarnCode
See `common.expectWarning()` for usage.

### opensslCli
* [&lt;boolean>]

Expand Down Expand Up @@ -369,6 +367,14 @@ original state after calling [`common.hijackStdOut()`][].

Path to the 'root' directory. either `/` or `c:\\` (windows)

### runWithInvalidFD(func)
* `func` [&lt;Function>]

Runs `func` with an invalid file descriptor that is an unsigned integer and
can be used to trigger `EBADF` as the first argument. If no such file
descriptor could be generated, a skip message will be printed and the `func`
will not be run.

### skip(msg)
* `msg` [&lt;string>]

Expand Down Expand Up @@ -695,12 +701,6 @@ The realpath of the testing temporary directory.

Deletes and recreates the testing temporary directory.

### getTTYfd()

Attempts to get a valid TTY file descriptor. Returns `-1` if it fails.

The TTY file descriptor is assumed to be capable of being writable.

## WPT Module

The wpt.js module is a port of parts of
Expand Down

0 comments on commit c31f0d0

Please sign in to comment.