From bb434a983c9738889a404019010fea105d51a67c Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Thu, 18 Feb 2021 12:29:37 -0500 Subject: [PATCH] doc: use HEAD for links in api docs MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Change links in api docs to use HEAD when they refer to the primary branch. Signed-off-by: Michael Dawson PR-URL: https://github.com/nodejs/node/pull/37437 Reviewed-By: Antoine du Hamel Reviewed-By: Darshan Sen Reviewed-By: Rich Trott Reviewed-By: James M Snell Reviewed-By: Benjamin Gruenbaum Reviewed-By: Luigi Pinca Reviewed-By: Juan José Arboleda --- doc/api/addons.md | 2 +- doc/api/documentation.md | 2 +- doc/api/embedding.md | 4 ++-- doc/api/intl.md | 4 ++-- doc/api/n-api.md | 2 +- doc/api/os.md | 2 +- doc/api/packages.md | 2 +- doc/api/process.md | 4 ++-- 8 files changed, 11 insertions(+), 11 deletions(-) diff --git a/doc/api/addons.md b/doc/api/addons.md index 979f04f82ce225..dba1c0df8739f7 100644 --- a/doc/api/addons.md +++ b/doc/api/addons.md @@ -1365,7 +1365,7 @@ console.log(result); [`Worker`]: worker_threads.md#worker_threads_class_worker [bindings]: https://github.com/TooTallNate/node-bindings [download]: https://github.com/nodejs/node-addon-examples -[examples]: https://github.com/nodejs/nan/tree/master/examples/ +[examples]: https://github.com/nodejs/nan/tree/HEAD/examples/ [installation instructions]: https://github.com/nodejs/node-gyp#installation [libuv]: https://github.com/libuv/libuv [node-gyp]: https://github.com/nodejs/node-gyp diff --git a/doc/api/documentation.md b/doc/api/documentation.md index d39aa30438aefc..a7a591d3733853 100644 --- a/doc/api/documentation.md +++ b/doc/api/documentation.md @@ -64,6 +64,6 @@ be unavoidable. [Semantic Versioning]: https://semver.org/ [V8 JavaScript engine]: https://v8.dev/ -[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md +[the contributing guide]: https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md [the issue tracker]: https://github.com/nodejs/node/issues/new [warning]: process.md#process_event_warning diff --git a/doc/api/embedding.md b/doc/api/embedding.md index f27b87821bd81c..7ec22fbab63850 100644 --- a/doc/api/embedding.md +++ b/doc/api/embedding.md @@ -223,5 +223,5 @@ int RunNodeInstance(MultiIsolatePlatform* platform, [CLI options]: cli.md [`process.memoryUsage()`]: process.md#process_process_memoryusage [deprecation policy]: deprecations.md -[embedtest.cc]: https://github.com/nodejs/node/blob/master/test/embedding/embedtest.cc -[src/node.h]: https://github.com/nodejs/node/blob/master/src/node.h +[embedtest.cc]: https://github.com/nodejs/node/blob/HEAD/test/embedding/embedtest.cc +[src/node.h]: https://github.com/nodejs/node/blob/HEAD/src/node.h diff --git a/doc/api/intl.md b/doc/api/intl.md index 6cb2f8c506421e..08571c637e56ea 100644 --- a/doc/api/intl.md +++ b/doc/api/intl.md @@ -189,12 +189,12 @@ to be helpful: dedicated to ECMA-402. ["ICU Data"]: http://userguide.icu-project.org/icudata -[BUILDING.md]: https://github.com/nodejs/node/blob/master/BUILDING.md +[BUILDING.md]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md [ECMA-262]: https://tc39.github.io/ecma262/ [ECMA-402]: https://tc39.github.io/ecma402/ [ICU]: http://site.icu-project.org/ [REPL]: repl.md#repl_repl -[Test262]: https://github.com/tc39/test262/tree/master/test/intl402 +[Test262]: https://github.com/tc39/test262/tree/HEAD/test/intl402 [WHATWG URL parser]: url.md#url_the_whatwg_url_api [`--icu-data-dir`]: cli.md#cli_icu_data_dir_file [`Date.prototype.toLocaleString()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString diff --git a/doc/api/n-api.md b/doc/api/n-api.md index 2c58c3510b2675..8685f7a5856496 100644 --- a/doc/api/n-api.md +++ b/doc/api/n-api.md @@ -6044,7 +6044,7 @@ This API may only be called from the main thread. [`napi_unwrap`]: #n_api_napi_unwrap [`napi_wrap`]: #n_api_napi_wrap [`node-addon-api`]: https://github.com/nodejs/node-addon-api -[`node_api.h`]: https://github.com/nodejs/node/blob/master/src/node_api.h +[`node_api.h`]: https://github.com/nodejs/node/blob/HEAD/src/node_api.h [`process.release`]: process.md#process_process_release [`uv_ref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_ref [`uv_unref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_unref diff --git a/doc/api/os.md b/doc/api/os.md index 8fee86f59ed55a..79622b33d3e860 100644 --- a/doc/api/os.md +++ b/doc/api/os.md @@ -1267,7 +1267,7 @@ The following process scheduling constants are exported by -[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os +[Android building]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os [EUID]: https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID [`SystemError`]: errors.md#errors_class_systemerror [`process.arch`]: process.md#process_process_arch diff --git a/doc/api/packages.md b/doc/api/packages.md index 5f6f1e78edc33c..3fb8b561d6565c 100644 --- a/doc/api/packages.md +++ b/doc/api/packages.md @@ -1104,7 +1104,7 @@ This field defines [subpath imports][] for the current package. [CommonJS]: modules.md [ES module]: esm.md [ES modules]: esm.md -[Node.js documentation for this section]: https://github.com/nodejs/node/blob/master/doc/api/packages.md#conditions-definitions +[Node.js documentation for this section]: https://github.com/nodejs/node/blob/HEAD/doc/api/packages.md#conditions-definitions [`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported [`esm`]: https://github.com/standard-things/esm#readme [`"exports"`]: #packages_exports diff --git a/doc/api/process.md b/doc/api/process.md index b9a0e08015cf14..f0304b1c2bdfb9 100644 --- a/doc/api/process.md +++ b/doc/api/process.md @@ -1805,7 +1805,7 @@ tarball. that are no longer supported). * `'Dubnium'` for the 10.x LTS line beginning with 10.13.0. * `'Erbium'` for the 12.x LTS line beginning with 12.13.0. - For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_ARCHIVE.md) + For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/HEAD/doc/changelogs/CHANGELOG_ARCHIVE.md) ```js @@ -2630,7 +2630,7 @@ cases: code will be `128` + `6`, or `134`. [Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization -[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os +[Android building]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os [Child Process]: child_process.md [Cluster]: cluster.md [Duplex]: stream.md#stream_duplex_and_transform_streams