benchmark: update README to include all benchmarks #46991
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
nodejs-github-bot
added
benchmark
|
Since it looks like we are not doing a good job at maintaining that table, what if we removed it? I don't think it's very useful, and without tests it seems inevitable that it will one day or another get back to an outdated state. |
|
As a beginner in benchmarking, I find the table not very helpful, and I believe that documents describing the |
I agree with @aduh95 here. This is the first time I saw this document :-) |
|
I've reverted the previous changes and included a description of the directory structure in place of the outdated table. |
aduh95
reviewed
Mar 8, 2023
cola119
removed
buffer
cola119
approved these changes
Mar 8, 2023
|
Can you update the initial commit title & pull-request title to a more relevant one @Theo-Steiner? |
anonrig
approved these changes
Mar 8, 2023
Theo-Steiner
force-pushed
the
docs/update-benchmarking-readme
branch
from
29f2380 to
101dc0a
Compare
The markdown table in `benchmark/README.md` has grown stale, no longer providing an overview over all existing benchmarks. As it has proven difficult to keep an exhaustive listing of available benchmarks up to date, this commit provides a description of how the directory is structured instead.
Theo-Steiner
force-pushed
the
docs/update-benchmarking-readme
branch
from
101dc0a to
182abbe
Compare
cola119
approved these changes
Mar 9, 2023
cola119
added
author ready
nodejs-github-bot
removed
the
commit-queue
|
Landed in 10c1ab0 |
targos
pushed a commit
that referenced
this pull request
Mar 13, 2023
The markdown table in `benchmark/README.md` has grown stale, no longer providing an overview over all existing benchmarks. As it has proven difficult to keep an exhaustive listing of available benchmarks up to date, this commit provides a description of how the directory is structured instead. PR-URL: #46991 Reviewed-By: Kohei Ueno <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]>
targos
pushed a commit
that referenced
this pull request
Mar 14, 2023
The markdown table in `benchmark/README.md` has grown stale, no longer providing an overview over all existing benchmarks. As it has proven difficult to keep an exhaustive listing of available benchmarks up to date, this commit provides a description of how the directory is structured instead. PR-URL: #46991 Reviewed-By: Kohei Ueno <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]>
danielleadams
pushed a commit
that referenced
this pull request
Apr 11, 2023
The markdown table in `benchmark/README.md` has grown stale, no longer providing an overview over all existing benchmarks. As it has proven difficult to keep an exhaustive listing of available benchmarks up to date, this commit provides a description of how the directory is structured instead. PR-URL: #46991 Reviewed-By: Kohei Ueno <[email protected]> Reviewed-By: Yagiz Nizipli <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Background
During #46731 @cola119 mentioned that the benchmark for readline was not documented in
benchmark/README.md.This PR will fix this (and also add other unmentioned benchmarks).
Update the markdown table in
benchmark/README.mdThe content of
benchmark/README.mdhas become stale, no longer providing an overview over all existing benchmarks. To address this, the markdown table has been updated to incorporate all current benchmarks.Move benchmarks for parts of submodules into the corresponding directory
Furthermore, some benchmarks were in separate directories from the benchmarks of their respective node submodules. These benchmarks have been moved into the directory of their submodule.