diff options
author | Rich Trott <rtrott@gmail.com> | 2019-12-03 13:15:10 -0800 |
---|---|---|
committer | Rich Trott <rtrott@gmail.com> | 2019-12-05 14:07:55 -0800 |
commit | 651c43082698ba3bfa4f2417944719f771c09f04 (patch) | |
tree | 17c204a1557985c094c608cd5892a615e630c915 | |
parent | e85471dedef4e6632a4a8a45b2b930cd85902782 (diff) | |
download | android-node-v8-651c43082698ba3bfa4f2417944719f771c09f04.tar.gz android-node-v8-651c43082698ba3bfa4f2417944719f771c09f04.tar.bz2 android-node-v8-651c43082698ba3bfa4f2417944719f771c09f04.zip |
doc,benchmark: move benchmark guide to benchmark directory
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>
-rw-r--r-- | benchmark/README.md | 8 | ||||
-rw-r--r-- | benchmark/_http-benchmarkers.js | 2 | ||||
-rw-r--r-- | benchmark/writing-and-running-benchmarks.md (renamed from doc/guides/writing-and-running-benchmarks.md) | 0 | ||||
-rw-r--r-- | doc/guides/contributing/pull-requests.md | 2 |
4 files changed, 6 insertions, 6 deletions
diff --git a/benchmark/README.md b/benchmark/README.md index 45256670fd..7e027c6e76 100644 --- a/benchmark/README.md +++ b/benchmark/README.md @@ -5,7 +5,7 @@ of different Node.js implementations and different ways of writing JavaScript run by the built-in JavaScript engine. For a detailed guide on how to write and run benchmarks in this -directory, see [the guide on benchmarks](../doc/guides/writing-and-running-benchmarks.md). +directory, see [the guide on benchmarks](writing-and-running-benchmarks.md). ## Table of Contents @@ -76,17 +76,17 @@ writing benchmarks. ### createBenchmark(fn, configs\[, options\]) -See [the guide on writing benchmarks](../doc/guides/writing-and-running-benchmarks.md#basics-of-a-benchmark). +See [the guide on writing benchmarks](writing-and-running-benchmarks.md#basics-of-a-benchmark). ### default\_http\_benchmarker The default benchmarker used to run HTTP benchmarks. -See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark). +See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark). ### PORT The default port used to run HTTP benchmarks. -See [the guide on writing HTTP benchmarks](../doc/guides/writing-and-running-benchmarks.md#creating-an-http-benchmark). +See [the guide on writing HTTP benchmarks](writing-and-running-benchmarks.md#creating-an-http-benchmark). ### sendResult(data) diff --git a/benchmark/_http-benchmarkers.js b/benchmark/_http-benchmarkers.js index a4d6230039..7dd06be265 100644 --- a/benchmark/_http-benchmarkers.js +++ b/benchmark/_http-benchmarkers.js @@ -5,7 +5,7 @@ const path = require('path'); const fs = require('fs'); const requirementsURL = - 'https://github.com/nodejs/node/blob/master/doc/guides/writing-and-running-benchmarks.md#http-benchmark-requirements'; + 'https://github.com/nodejs/node/blob/master/benchmark/writing-and-running-benchmarks.md#http-benchmark-requirements'; // The port used by servers and wrk exports.PORT = Number(process.env.PORT) || 12346; diff --git a/doc/guides/writing-and-running-benchmarks.md b/benchmark/writing-and-running-benchmarks.md index 6097830aee..6097830aee 100644 --- a/doc/guides/writing-and-running-benchmarks.md +++ b/benchmark/writing-and-running-benchmarks.md diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index cabc548be0..cd1bccd20c 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -585,7 +585,7 @@ If you want to know more about the code review and the landing process, see the [Collaborator Guide][]. [approved]: #getting-approvals-for-your-pull-request -[benchmark results]: ../writing-and-running-benchmarks.md +[benchmark results]: ../../../benchmark/writing-and-running-benchmarks.md [Building guide]: ../../../BUILDING.md [CI (Continuous Integration) test run]: #ci-testing [Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md |