summaryrefslogtreecommitdiff
path: root/benchmark/README.md
AgeCommit message (Collapse)Author
2019-12-05doc,benchmark: move benchmark guide to benchmark directoryRich Trott
The doc/guides directory looks like a place for guides to using Node.js but it's actually where we store development/internal documentation. Move the benchmark guide to the benchmark directory where someone (who doesn't know that bit of somewhat-surprising information) is more likely to find it. PR-URL: https://github.com/nodejs/node/pull/30781 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-10-15doc: prepare miscellaneous docs for new markdown lint rulesRich Trott
Prepare the final few documents that haven't been updated to always use `[]` with reference links and to escape `[` and `]` for things that aren't links in markdown files. PR-URL: https://github.com/nodejs/node/pull/29963 Reviewed-By: Masashi Hirano <shisama07@gmail.com> Reviewed-By: David Carlier <devnexen@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-08-31doc: remove multiple consecutive blank linesNick Schonning
These are rendered as single breaks. Addresses Markdownlint MD012 rule. PR-URL: https://github.com/nodejs/node/pull/29352 Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
2019-03-19benchmark: use gfm for claritygengjiawen
PR-URL: https://github.com/nodejs/node/pull/26710 Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de> Reviewed-By: Anto Aravinth <anto.aravinth.cse@gmail.com> Reviewed-By: Richard Lau <riclau@uk.ibm.com>
2019-01-09doc: update benchmark docKazushi Kitaya
Benchmark for arrays no longer exists, but it was still referenced in documentation. Refs: https://github.com/nodejs/node/pull/21831 PR-URL: https://github.com/nodejs/node/pull/25367 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2017-08-04http2: add tests and benchmarksJames M Snell
PR-URL: https://github.com/nodejs/node/pull/14239 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2017-03-06benchmark: cleanup after forced optimization dropBartosz Sosnowski
This removes all instances of %OptimizeFunctionOnNextCall from common.js and README.md PR-URL: https://github.com/nodejs/node/pull/9615 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2017-02-17doc: add benchmark/README.md and fix guideJoyee Cheung
* Write a new benchmark/README.md describing the benchmark directory layout and common API. * Fix the moved benchmarking guide accordingly, add tips about how to get the help text from the benchmarking tools. PR-URL: https://github.com/nodejs/node/pull/11237 Fixes: https://github.com/nodejs/node/issues/11190 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
2017-02-17doc: move benchmark/README.md to doc/guidesJoyee Cheung
Since benchmark/README.md is in fact a guide on how to write and run benchmarks, move it to doc/guides. PR-URL: https://github.com/nodejs/node/pull/11237 Fixes: https://github.com/nodejs/node/issues/11190 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
2017-02-10benchmark: fix typosNikolai Vavilov
PR-URL: https://github.com/nodejs/node/pull/11287 Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Joyee Cheung <joyeec9h3@gmail.com>
2017-01-14benchmark: use "confidence" in output of compare.RJoyee Cheung
Use the word "confidence" to indicate the confidence level of the p value so it's easier to understand. With this change more stars in the output of compare.R means higher confidence level (lower significance level). PR-URL: https://github.com/nodejs/node/pull/10737 Refs: https://github.com/nodejs/node/pull/10439 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
2017-01-04benchmark: allow benchmarks to specify flagsJoyee Cheung
* Give createBenchmark and the Benchmark constructor a third argument for specifying the command line flags that this benchmark should be run with. The benchmarks are no longer run with --expose-internals by default, they will need to explicitly pass the flags. * Rename options to configs in createBenchmark and the Benchmark constructor to match the documentation since they are not optional. * Comment the properties of a Benchmark object Also improve the documentation about creating benchmarks * Add detailed description of the arguments of `createBenchmark` * Describe the two passes of running the benchmarks * Suggest what kind of code should go where in the benchmark example PR-URL: https://github.com/nodejs/node/pull/10448 Reviewed-By: Andreas Madsen <amwebdk@gmail.com> Reviewed-By: Brian White <mscdex@mscdex.net>
2016-12-15doc: document R CRAN mirror processLucas Holmquist
The current benchmark docs showing how to install R packages doesn't go into how to specify a CRAN mirror. This commit shows how to specify the repo parameter when installing a package. Fixes: https://github.com/nodejs/node/issues/10204 PR-URL: https://github.com/nodejs/node/pull/10211 Reviewed-By: Andreas Madsen <amwebdk@gmail.com>
2016-11-21tools: disallow trailing whitespace for markdownSam Roberts
markdown had a dispensation because 2 or more trailing spaces triggers a new paragraph. There are no examples of that usage in Node, all trailing whitespace found were mistakes, and the dispensation is now removed. See: https://github.com/nodejs/node/pull/9620 PR-URL: https://github.com/nodejs/node/pull/9676 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Roman Reiss <me@silverwind.io> Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com>
2016-11-04benchmark: add trailing newline for consistencyRoman Reiss
PR-URL: https://github.com/nodejs/node/pull/9410 Fixes: https://github.com/nodejs/node/issues/9402 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Sakthipriyan Vairamani <thechargingvolcano@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Minwoo Jung <jmwsoft@gmail.com>
2016-09-30benchmark: add info about required Unix toolsBartosz Sosnowski
This adds note to README.md about Unix tools being required by some benchmarks PR-URL: https://github.com/nodejs/node/pull/8788 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Gibson Fahnestock <gibfahn@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
2016-08-31benchmark: support for multiple http benchmarkersBartosz Sosnowski
This adds support for multiple HTTP benchmarkers. Adds autocannon as the secondary benchmarker. PR-URL: https://github.com/nodejs/node/pull/8140 Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
2016-08-04doc: *.md formatting fixes in the benchmark dirСковорода Никита Андреевич
* Add language specification for the txt code blocks. * Move the definitions to the bottom. Ref: https://github.com/nodejs/node/pull/7727 PR-URL: https://github.com/nodejs/node/pull/7727 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Michaël Zasso <mic.besace@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
2016-07-26benchmark: update docs after refactorAndreas Madsen
PR-URL: https://github.com/nodejs/node/pull/7094 Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2016-07-26benchmark: move cli parts of common.js into run.jsAndreas Madsen
It wasn't obviouse that common.js was the main cli tool. PR-URL: https://github.com/nodejs/node/pull/7094 Reviewed-By: Trevor Norris <trev.norris@gmail.com> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com> Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Anna Henningsen <anna@addaleax.net>
2015-09-15doc: rename from iojs(1) to node(1) in benchmarksDmitry Vasilyev
Examples in the benchmark readme previously sill referenced iojs(1). PR-URL: https://github.com/nodejs/node/pull/2884 Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-08-23node: rename from io.js to nodecjihrig
This commit replaces instances of io.js with Node.js, based on the recent convergence. There are some remaining instances of io.js, related to build and the installer. Fixes: https://github.com/nodejs/node/issues/2361 PR-URL: https://github.com/nodejs/node/pull/2367 Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: João Reis <reis@janeasystems.com>
2015-06-29benchmark: fix typo in READMERich Trott
PR-URL: https://github.com/nodejs/io.js/pull/2067 Reviewed-By: Brian White <mscdex@mscdex.net> Reviewed-By: Jeremiah Senkpiel <fishrock123@rocketmail.com>
2015-06-24doc: clarify prerequisites in benchmark/README.mdJeremiah Senkpiel
PR-URL: https://github.com/nodejs/io.js/pull/2034 Reviewed-By: Evan Lucas <evanlucas@me.com> Reviewed-By: Trevor Norris <trev.norris@gmail.com>
2015-06-15doc: benchmark/README.md copyeditRich Trott
PR-URL: https://github.com/nodejs/io.js/pull/1970 Reviewed-By: Johan Bergström <bugs@bergstroem.nu>
2015-03-04benchmark: check for wrk ahead of running benchmarksJohan Bergström
PR-URL: https://github.com/iojs/io.js/pull/982 Reviewed-By: Rod Vagg <rod@vagg.org>
2015-03-04build: remove tools/wrk from the treeJohan Bergström
wrk is an optional tool that some of the http benchmarks uses. The removal doesn't affect any users. Developers are assumed to install it before running the tests. This change reduces the tarball by 5% PR-URL: https://github.com/iojs/io.js/pull/982 Reviewed-By: Rod Vagg <rod@vagg.org>
2015-01-28doc: add more info to benchmark/README.mdFishrock123
Adds info on the `wrk` prerequisite for http benchmarks and how to run benchmarks with options. PR-URL: https://github.com/iojs/io.js/pull/629 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl> Reviewed-By: Evan Lucas <evanlucas@me.com>
2015-01-14benchmark: fix command name in benchmark scriptsYosuke Furukawa
PR-URL: https://github.com/iojs/io.js/pull/410 Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
2014-05-28doc: Add a README for benchmark testsRaymond Feng
The README.md documents how to run node core benchmark tests and how to write new tests.
generated by cgit v1.2.3 (git 2.39.1) at 2024-05-01 08:39:19 +0000