Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: fix misplaced entries in test/common doc #20117

Closed
wants to merge 1 commit into from
+15 −15
Closed

doc: fix misplaced entries in test/common doc #20117

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions test/common/README.md
View file
Open in desktop
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 [<string>]
* return [<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` [<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
* [<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
* [<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` [<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` [<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