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.

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

tools: fixup docs and run known_issues by default #21910

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 7 additions & 3 deletions test/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,9 +16,13 @@ GitHub with the `autocrlf` git config flag set to true.
|Directory |Runs on CI |Purpose |
|-------------------|---------------|---------------|
|abort |Yes |Tests for when the ``` --abort-on-uncaught-exception ``` flag is used.|
|addons |Yes |Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon to function properly.|
|cctest |Yes |C++ test that is run as part of the build process.|
|addons |Yes |Tests for [addon](https://nodejs.org/api/addons.html) functionality along with some tests that require an addon to function properly.|
|addons-napi |Yes |Tests for [n-api](https://nodejs.org/api/n-api.html) functionality.|
|async-hooks |Yes |Tests for [async_hooks](https://nodejs.org/api/async_hooks.html) functionality.|
|cctest |Yes |C++ tests that are run as part of the build process.|
|code-cache |No |Tests for a Node.js binary compiled with V8 code cache.|
|common | |Common modules shared among many tests. [Documentation](./common/README.md)|
|doctool |Yes |Tests for the documentation generator.|
|es-module |Yes |Test ESM module loading.|
|fixtures | |Test fixtures used in various tests throughout the test suite.|
|gc |No |Tests for garbage collection related functionality.|
Expand All @@ -31,7 +35,7 @@ GitHub with the `autocrlf` git config flag set to true.
|sequential |Yes |Various tests that are run sequentially.|
|testpy | |Test configuration utility used by various test suites.|
|tick-processor |No |Tests for the V8 tick processor integration. The tests are for the logic in ```lib/internal/v8_prof_processor.js``` and ```lib/internal/v8_prof_polyfill.js```. The tests confirm that the profile processor packages the correct set of scripts from V8 and introduces the correct platform specific logic.|
|timers |No |Tests for [timing utilities](https://nodejs.org/api/timers.html) (```setTimeout``` and ```setInterval```).|
|v8-updates |No |Tests for V8 performance integration.|

_When a new test directory is added, make sure to update the `CI_JS_SUITES`
variable in the `Makefile` and the `js_test_suites` variable in
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This bottom note can probably be removed too as it looks like both CI_JS_SUITES and js_test_suites are default rather than a list of test directories. This can be done in another PR if you'd rather just land this PR as-is.

Expand Down
2 changes: 0 additions & 2 deletions tools/test.py
Original file line number Diff line number Diff line change
Expand Up @@ -1554,9 +1554,7 @@ def PrintCrashed(code):
'gc',
'internet',
'pummel',
'test-known-issues',
'tick-processor',
'timers',
'v8-updates'
]

Expand Down