From 74f0760a9b071e645c05abd4961344afe1c70f1b Mon Sep 17 00:00:00 2001 From: Michael Dawson Date: Wed, 17 Feb 2021 14:49:52 -0500 Subject: [PATCH] doc: use HEAD in links where possible Where possible used HEAD in links Signed-off-by: Michael Dawson PR-URL: https://github.com/nodejs/node/pull/37421 Reviewed-By: Rich Trott Reviewed-By: Antoine du Hamel Reviewed-By: Zijian Liu Reviewed-By: Darshan Sen Reviewed-By: James M Snell Reviewed-By: Luigi Pinca --- doc/guides/collaborator-guide.md | 6 +++--- doc/guides/contributing/code-of-conduct.md | 2 +- doc/guides/contributing/issues.md | 2 +- doc/guides/contributing/pull-requests.md | 4 ++-- doc/guides/cpp-style-guide.md | 4 ++-- doc/guides/doc-style-guide.md | 2 +- doc/guides/maintaining-V8.md | 2 +- doc/guides/maintaining-icu.md | 2 +- doc/guides/releases.md | 10 +++++----- doc/guides/security-release-process.md | 6 +++--- doc/guides/writing-and-running-benchmarks.md | 2 +- doc/guides/writing-tests.md | 12 ++++++------ 12 files changed, 27 insertions(+), 27 deletions(-) diff --git a/doc/guides/collaborator-guide.md b/doc/guides/collaborator-guide.md index 73e6c06ba448e5..fb95a4e51465e2 100644 --- a/doc/guides/collaborator-guide.md +++ b/doc/guides/collaborator-guide.md @@ -378,7 +378,7 @@ For pull requests introducing new core modules: Node-API provides an ABI-stable API guaranteed for future Node.js versions. Node-API additions call for unusual care and scrutiny. If a change adds to `node_api.h`, `js_native_api.h`, `node_api_types.h`, or `js_native_api_types.h`, -consult [the relevant guide](https://github.com/nodejs/node/blob/master/doc/guides/adding-new-napi-api.md). +consult [the relevant guide](https://github.com/nodejs/node/blob/HEAD/doc/guides/adding-new-napi-api.md). ### Deprecations @@ -815,8 +815,8 @@ If you cannot find who to cc for a file, `git shortlog -n -s ` can help. [commit message guidelines]: contributing/pull-requests.md#commit-message-guidelines [commit-example]: https://github.com/nodejs/node/commit/b636ba8186 [git-email]: https://help.github.com/articles/setting-your-commit-email-address-in-git/ -[git-node]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md -[git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-metadata +[git-node]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md +[git-node-metadata]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md#git-node-metadata [git-username]: https://help.github.com/articles/setting-your-username-in-git/ [node-core-utils-credentials]: https://github.com/nodejs/node-core-utils#setting-up-credentials [node-core-utils-issues]: https://github.com/nodejs/node-core-utils/issues diff --git a/doc/guides/contributing/code-of-conduct.md b/doc/guides/contributing/code-of-conduct.md index 6e2c1db36e9f60..9c3ad120b13d34 100644 --- a/doc/guides/contributing/code-of-conduct.md +++ b/doc/guides/contributing/code-of-conduct.md @@ -40,4 +40,4 @@ that you *might* be wrong is critical for any successful open collaboration. Don't be a bad actor. -[Code of Conduct]: https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md +[Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md diff --git a/doc/guides/contributing/issues.md b/doc/guides/contributing/issues.md index c4c0526e65ec80..fdb30c6f71c43d 100644 --- a/doc/guides/contributing/issues.md +++ b/doc/guides/contributing/issues.md @@ -53,7 +53,7 @@ project's GitHub organization plus a few contributions to the project (commenting on issues or PRs) can apply for and become a triager. Open a PR on the README.md of this project with: i) a request to be added as a triager, ii) the motivation for becoming a triager, and iii) agreement on reading, -understanding, and adhering to the project's [Code Of Conduct](https://github.com/nodejs/admin/blob/master/CODE_OF_CONDUCT.md). +understanding, and adhering to the project's [Code Of Conduct](https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md). The triage role enables the ability to carry out the most common triage activities, such as applying labels and closing/reopening/assigning issues. diff --git a/doc/guides/contributing/pull-requests.md b/doc/guides/contributing/pull-requests.md index 8ec694cb949962..82a84e86c80e94 100644 --- a/doc/guides/contributing/pull-requests.md +++ b/doc/guides/contributing/pull-requests.md @@ -591,7 +591,7 @@ More than one subsystem may be valid for any particular issue or pull request. [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 +[Code of Conduct]: https://github.com/nodejs/admin/blob/HEAD/CODE_OF_CONDUCT.md [Collaborator Guide]: ../collaborator-guide.md [IRC in the #node-dev channel]: https://webchat.freenode.net?channels=node-dev&uio=d4 [Onboarding guide]: ../../../onboarding.md @@ -600,5 +600,5 @@ More than one subsystem may be valid for any particular issue or pull request. [guide for writing tests in Node.js]: ../writing-tests.md [hiding-a-comment]: https://help.github.com/articles/managing-disruptive-comments/#hiding-a-comment [https://ci.nodejs.org/]: https://ci.nodejs.org/ -[pull request template]: https://raw.githubusercontent.com/nodejs/node/master/.github/PULL_REQUEST_TEMPLATE.md +[pull request template]: https://raw.githubusercontent.com/nodejs/node/HEAD/.github/PULL_REQUEST_TEMPLATE.md [running tests]: ../../../BUILDING.md#running-tests diff --git a/doc/guides/cpp-style-guide.md b/doc/guides/cpp-style-guide.md index b29fc070c3a8e2..8215b43ec22b4d 100644 --- a/doc/guides/cpp-style-guide.md +++ b/doc/guides/cpp-style-guide.md @@ -400,7 +400,7 @@ even `try` and `catch` **will** break. [R.20]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rr-owner [R.21]: https://isocpp.github.io/CppCoreGuidelines/CppCoreGuidelines#Rr-unique [Run Time Type Information]: https://en.wikipedia.org/wiki/Run-time_type_information -[aliased_buffer.h]: https://github.com/nodejs/node/blob/master/src/aliased_buffer.h#L12 +[aliased_buffer.h]: https://github.com/nodejs/node/blob/HEAD/src/aliased_buffer.h#L12 [cppref_auto_ptr]: https://en.cppreference.com/w/cpp/memory/auto_ptr -[errors]: https://github.com/nodejs/node/blob/master/doc/guides/using-internal-errors.md +[errors]: https://github.com/nodejs/node/blob/HEAD/doc/guides/using-internal-errors.md [without C++ exception handling]: https://gcc.gnu.org/onlinedocs/libstdc++/manual/using_exceptions.html#intro.using.exception.no diff --git a/doc/guides/doc-style-guide.md b/doc/guides/doc-style-guide.md index c5b5b80f2ac8a3..26322e6c7ba3b0 100644 --- a/doc/guides/doc-style-guide.md +++ b/doc/guides/doc-style-guide.md @@ -108,5 +108,5 @@ For topics not covered here, refer to the [Microsoft Writing Style Guide][]. [`remark-preset-lint-node`]: https://github.com/nodejs/remark-preset-lint-node [doctools README]: ../../tools/doc/README.md [info string]: https://github.github.com/gfm/#info-string -[language]: https://github.com/highlightjs/highlight.js/blob/master/SUPPORTED_LANGUAGES.md +[language]: https://github.com/highlightjs/highlight.js/blob/HEAD/SUPPORTED_LANGUAGES.md [plugin]: https://editorconfig.org/#download diff --git a/doc/guides/maintaining-V8.md b/doc/guides/maintaining-V8.md index 291c7eb0d9aadd..1063b1d2db99b6 100644 --- a/doc/guides/maintaining-V8.md +++ b/doc/guides/maintaining-V8.md @@ -431,4 +431,4 @@ as their support has ended. [V8MergingPatching]: https://github.com/v8/v8/wiki/Merging%20&%20Patching [V8TemplateMergeRequest]: https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20merge%20request [V8TemplateUpstreamBug]: https://bugs.chromium.org/p/v8/issues/entry?template=Node.js%20upstream%20bug -[`git-node`]: https://github.com/nodejs/node-core-utils/blob/master/docs/git-node.md#git-node-v8 +[`git-node`]: https://github.com/nodejs/node-core-utils/blob/HEAD/docs/git-node.md#git-node-v8 diff --git a/doc/guides/maintaining-icu.md b/doc/guides/maintaining-icu.md index f98e129c5a86df..8de05a085bf041 100644 --- a/doc/guides/maintaining-icu.md +++ b/doc/guides/maintaining-icu.md @@ -44,7 +44,7 @@ and announces them on the [`tz-announce`](https://mm.icann.org/pipermail/tz-anno mailing list. The Unicode project takes new releases and publishes -[updated time zone data files](https://github.com/unicode-org/icu-data/tree/master/tzdata/icunew) +[updated time zone data files](https://github.com/unicode-org/icu-data/tree/HEAD/tzdata/icunew) in the icu/icu-data repository. All modern versions of Node.js use the version 44 ABI of the time zone data diff --git a/doc/guides/releases.md b/doc/guides/releases.md index 7fa86734e75420..c2eaadbdbeafc8 100644 --- a/doc/guides/releases.md +++ b/doc/guides/releases.md @@ -194,7 +194,7 @@ When cherry-picking commits, if there are simple conflicts you can resolve them. Otherwise, add the `backport-requested-vN.x` label to the original PR and post a comment stating that it does not land cleanly and will require a backport PR. You can refer the owner of the PR to the "[Backporting to Release - Lines](https://github.com/nodejs/node/blob/master/doc/guides/backporting-to-release-lines.md)" guide. + Lines](https://github.com/nodejs/node/blob/HEAD/doc/guides/backporting-to-release-lines.md)" guide. If commits were cherry-picked in this step, check that the test still pass and push to the staging branch to keep it up-to-date. @@ -249,7 +249,7 @@ defined, so if in doubt, please confer with someone that will have a more informed perspective, such as a member of the NAN team. A registry of currently used `NODE_MODULE_VERSION` values is maintained at -. +. When bumping `NODE_MODULE_VERSION`, you should choose a new value not listed in the registry. Also include a change to the registry in your commit to reflect the newly used value. @@ -882,8 +882,8 @@ commits may be listed as notable changes on a case-by-case basis. Use your judgment there. [Build issue tracker]: https://github.com/nodejs/build/issues/new -[CI lockdown procedure]: https://github.com/nodejs/build/blob/master/doc/jenkins-guide.md#restricting-access-for-security-releases -[Partner Communities]: https://github.com/nodejs/community-committee/blob/master/governance/PARTNER_COMMUNITIES.md -[nodejs.org release-post.js script]: https://github.com/nodejs/nodejs.org/blob/master/scripts/release-post.js +[CI lockdown procedure]: https://github.com/nodejs/build/blob/HEAD/doc/jenkins-guide.md#restricting-access-for-security-releases +[Partner Communities]: https://github.com/nodejs/community-committee/blob/HEAD/governance/PARTNER_COMMUNITIES.md +[nodejs.org release-post.js script]: https://github.com/nodejs/nodejs.org/blob/HEAD/scripts/release-post.js [nodejs.org repository]: https://github.com/nodejs/nodejs.org [webchat.freenode.net]: https://webchat.freenode.net/ diff --git a/doc/guides/security-release-process.md b/doc/guides/security-release-process.md index 0ada9b63742615..5609e40739d3fb 100644 --- a/doc/guides/security-release-process.md +++ b/doc/guides/security-release-process.md @@ -57,11 +57,11 @@ information described. ## Release day -* [ ] [Lock CI](https://github.com/nodejs/build/blob/master/doc/jenkins-guide.md#before-the-release) +* [ ] [Lock CI](https://github.com/nodejs/build/blob/HEAD/doc/jenkins-guide.md#before-the-release) * [ ] The releaser(s) run the release process to completion. -* [ ] [Unlock CI](https://github.com/nodejs/build/blob/master/doc/jenkins-guide.md#after-the-release) +* [ ] [Unlock CI](https://github.com/nodejs/build/blob/HEAD/doc/jenkins-guide.md#after-the-release) * [ ] Post-release announcement in reply [email][]: ***LINK TO EMAIL*** @@ -84,7 +84,7 @@ information described. links to the release blogs in the "Public Reference" section) * [ ] PR machine-readable JSON descriptions of the vulnerabilities to the - [core](https://github.com/nodejs/security-wg/tree/master/vuln/core) + [core](https://github.com/nodejs/security-wg/tree/HEAD/vuln/core) vulnerability DB. ***LINK TO PR*** * [ ] Close this issue diff --git a/doc/guides/writing-and-running-benchmarks.md b/doc/guides/writing-and-running-benchmarks.md index 510fe8636cb353..7e00e65a7b8b67 100644 --- a/doc/guides/writing-and-running-benchmarks.md +++ b/doc/guides/writing-and-running-benchmarks.md @@ -560,7 +560,7 @@ Supported options keys are: benchmarker [autocannon]: https://github.com/mcollina/autocannon -[benchmark-ci]: https://github.com/nodejs/benchmarking/blob/master/docs/core_benchmarks.md +[benchmark-ci]: https://github.com/nodejs/benchmarking/blob/HEAD/docs/core_benchmarks.md [git-for-windows]: https://git-scm.com/download/win [nghttp2.org]: https://nghttp2.org [t-test]: https://en.wikipedia.org/wiki/Student%27s_t-test#Equal_or_unequal_sample_sizes.2C_unequal_variances diff --git a/doc/guides/writing-tests.md b/doc/guides/writing-tests.md index 0d33aabb061dee..993c20f6aa681c 100644 --- a/doc/guides/writing-tests.md +++ b/doc/guides/writing-tests.md @@ -161,7 +161,7 @@ platforms. ### The *common* API Make use of the helpers from the `common` module as much as possible. Please -refer to the [common file documentation](https://github.com/nodejs/node/tree/master/test/common) +refer to the [common file documentation](https://github.com/nodejs/node/tree/HEAD/test/common) for the full details of the helpers. #### common.mustCall @@ -231,7 +231,7 @@ instead. #### Countdown Module -The common [Countdown module](https://github.com/nodejs/node/tree/master/test/common#countdown-module) +The common [Countdown module](https://github.com/nodejs/node/tree/HEAD/test/common#countdown-module) provides a simple countdown mechanism for tests that require a particular action to be taken after a given number of completed tasks (for instance, shutting down an HTTP server after a specific number of requests). @@ -454,9 +454,9 @@ Nightly coverage reports for the Node.js master branch are available at [ASCII]: https://man7.org/linux/man-pages/man7/ascii.7.html [Google Test]: https://github.com/google/googletest -[Test Coverage section of the Building guide]: https://github.com/nodejs/node/blob/master/BUILDING.md#running-coverage -[`common` module]: https://github.com/nodejs/node/blob/master/test/common/README.md +[Test Coverage section of the Building guide]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#running-coverage +[`common` module]: https://github.com/nodejs/node/blob/HEAD/test/common/README.md [all maintained branches]: https://github.com/nodejs/lts -[directory structure overview]: https://github.com/nodejs/node/blob/master/test/README.md#test-directories +[directory structure overview]: https://github.com/nodejs/node/blob/HEAD/test/README.md#test-directories [node.green]: https://node.green/ -[test fixture]: https://github.com/google/googletest/blob/master/googletest/docs/primer.md#test-fixtures-using-the-same-data-configuration-for-multiple-tests-same-data-multiple-tests +[test fixture]: https://github.com/google/googletest/blob/HEAD/googletest/docs/primer.md#test-fixtures-using-the-same-data-configuration-for-multiple-tests-same-data-multiple-tests