Skip to content

Commit bb434a9

Browse files
mhdawsontargos
authored andcommittedMay 1, 2021
doc: use HEAD for links in api docs
Change links in api docs to use HEAD when they refer to the primary branch. Signed-off-by: Michael Dawson <mdawson@devrus.com> PR-URL: #37437 Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Juan José Arboleda <soyjuanarbol@gmail.com>
1 parent 39ef3bd commit bb434a9

File tree

8 files changed

+11
-11
lines changed

8 files changed

+11
-11
lines changed
 

‎doc/api/addons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1365,7 +1365,7 @@ console.log(result);
13651365
[`Worker`]: worker_threads.md#worker_threads_class_worker
13661366
[bindings]: https://github.com/TooTallNate/node-bindings
13671367
[download]: https://github.com/nodejs/node-addon-examples
1368-
[examples]: https://github.com/nodejs/nan/tree/master/examples/
1368+
[examples]: https://github.com/nodejs/nan/tree/HEAD/examples/
13691369
[installation instructions]: https://github.com/nodejs/node-gyp#installation
13701370
[libuv]: https://github.com/libuv/libuv
13711371
[node-gyp]: https://github.com/nodejs/node-gyp

‎doc/api/documentation.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,6 @@ be unavoidable.
6464

6565
[Semantic Versioning]: https://semver.org/
6666
[V8 JavaScript engine]: https://v8.dev/
67-
[the contributing guide]: https://github.com/nodejs/node/blob/master/CONTRIBUTING.md
67+
[the contributing guide]: https://github.com/nodejs/node/blob/HEAD/CONTRIBUTING.md
6868
[the issue tracker]: https://github.com/nodejs/node/issues/new
6969
[warning]: process.md#process_event_warning

‎doc/api/embedding.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -223,5 +223,5 @@ int RunNodeInstance(MultiIsolatePlatform* platform,
223223
[CLI options]: cli.md
224224
[`process.memoryUsage()`]: process.md#process_process_memoryusage
225225
[deprecation policy]: deprecations.md
226-
[embedtest.cc]: https://github.com/nodejs/node/blob/master/test/embedding/embedtest.cc
227-
[src/node.h]: https://github.com/nodejs/node/blob/master/src/node.h
226+
[embedtest.cc]: https://github.com/nodejs/node/blob/HEAD/test/embedding/embedtest.cc
227+
[src/node.h]: https://github.com/nodejs/node/blob/HEAD/src/node.h

‎doc/api/intl.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -189,12 +189,12 @@ to be helpful:
189189
dedicated to ECMA-402.
190190

191191
["ICU Data"]: http://userguide.icu-project.org/icudata
192-
[BUILDING.md]: https://github.com/nodejs/node/blob/master/BUILDING.md
192+
[BUILDING.md]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md
193193
[ECMA-262]: https://tc39.github.io/ecma262/
194194
[ECMA-402]: https://tc39.github.io/ecma402/
195195
[ICU]: http://site.icu-project.org/
196196
[REPL]: repl.md#repl_repl
197-
[Test262]: https://github.com/tc39/test262/tree/master/test/intl402
197+
[Test262]: https://github.com/tc39/test262/tree/HEAD/test/intl402
198198
[WHATWG URL parser]: url.md#url_the_whatwg_url_api
199199
[`--icu-data-dir`]: cli.md#cli_icu_data_dir_file
200200
[`Date.prototype.toLocaleString()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toLocaleString

‎doc/api/n-api.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6044,7 +6044,7 @@ This API may only be called from the main thread.
60446044
[`napi_unwrap`]: #n_api_napi_unwrap
60456045
[`napi_wrap`]: #n_api_napi_wrap
60466046
[`node-addon-api`]: https://github.com/nodejs/node-addon-api
6047-
[`node_api.h`]: https://github.com/nodejs/node/blob/master/src/node_api.h
6047+
[`node_api.h`]: https://github.com/nodejs/node/blob/HEAD/src/node_api.h
60486048
[`process.release`]: process.md#process_process_release
60496049
[`uv_ref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_ref
60506050
[`uv_unref`]: https://docs.libuv.org/en/v1.x/handle.html#c.uv_unref

‎doc/api/os.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1267,7 +1267,7 @@ The following process scheduling constants are exported by
12671267
</tr>
12681268
</table>
12691269

1270-
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
1270+
[Android building]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os
12711271
[EUID]: https://en.wikipedia.org/wiki/User_identifier#Effective_user_ID
12721272
[`SystemError`]: errors.md#errors_class_systemerror
12731273
[`process.arch`]: process.md#process_process_arch

‎doc/api/packages.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1104,7 +1104,7 @@ This field defines [subpath imports][] for the current package.
11041104
[CommonJS]: modules.md
11051105
[ES module]: esm.md
11061106
[ES modules]: esm.md
1107-
[Node.js documentation for this section]: https://github.com/nodejs/node/blob/master/doc/api/packages.md#conditions-definitions
1107+
[Node.js documentation for this section]: https://github.com/nodejs/node/blob/HEAD/doc/api/packages.md#conditions-definitions
11081108
[`ERR_PACKAGE_PATH_NOT_EXPORTED`]: errors.md#errors_err_package_path_not_exported
11091109
[`esm`]: https://github.com/standard-things/esm#readme
11101110
[`"exports"`]: #packages_exports

‎doc/api/process.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -1805,7 +1805,7 @@ tarball.
18051805
that are no longer supported).
18061806
* `'Dubnium'` for the 10.x LTS line beginning with 10.13.0.
18071807
* `'Erbium'` for the 12.x LTS line beginning with 12.13.0.
1808-
For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/master/doc/changelogs/CHANGELOG_ARCHIVE.md)
1808+
For other LTS Release code names, see [Node.js Changelog Archive](https://github.com/nodejs/node/blob/HEAD/doc/changelogs/CHANGELOG_ARCHIVE.md)
18091809

18101810
<!-- eslint-skip -->
18111811
```js
@@ -2630,7 +2630,7 @@ cases:
26302630
code will be `128` + `6`, or `134`.
26312631

26322632
[Advanced serialization for `child_process`]: child_process.md#child_process_advanced_serialization
2633-
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
2633+
[Android building]: https://github.com/nodejs/node/blob/HEAD/BUILDING.md#androidandroid-based-devices-eg-firefox-os
26342634
[Child Process]: child_process.md
26352635
[Cluster]: cluster.md
26362636
[Duplex]: stream.md#stream_duplex_and_transform_streams

0 commit comments

Comments
 (0)
Please sign in to comment.