Skip to content

Commit a023193

Browse files
vsemozhetbytMylesBorins
authored andcommitted
doc: fix/add link to Android info
We have two notes in API docs about Android support: the first has no links, the second links to the table of supported OSs where Android is not mentioned which may be confusing. This PR makes both notes link to dedicated Android part of BUILDING.md. Backport-PR-URL: #22386 PR-URL: #19004 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Colin Ihrig <cjihrig@gmail.com> Reviewed-By: Yuta Hiroto <hello@about-hiroppy.com>
1 parent 9c781f0 commit a023193

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

doc/api/os.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -324,7 +324,7 @@ Equivalent to [`process.platform`][].
324324

325325
*Note*: The value `'android'` may also be returned if the Node.js is built on
326326
the Android operating system. However, Android support in Node.js is considered
327-
to be experimental at this time.
327+
[to be experimental][Android building] at this time.
328328

329329
## os.release()
330330
<!-- YAML
@@ -1185,4 +1185,5 @@ The following error codes are specific to the Windows operating system:
11851185

11861186
[`process.arch`]: process.html#process_process_arch
11871187
[`process.platform`]: process.html#process_process_platform
1188+
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
11881189
[uname(3)]: https://linux.die.net/man/3/uname

doc/api/process.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1415,7 +1415,7 @@ console.log(`This platform is ${process.platform}`);
14151415

14161416
The value `'android'` may also be returned if the Node.js is built on the
14171417
Android operating system. However, Android support in Node.js
1418-
[is experimental][Supported platforms].
1418+
[is experimental][Android building].
14191419

14201420
## process.ppid
14211421
<!-- YAML
@@ -1942,6 +1942,7 @@ cases:
19421942
[`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
19431943
[`require.main`]: modules.html#modules_accessing_the_main_module
19441944
[`setTimeout(fn, 0)`]: timers.html#timers_settimeout_callback_delay_args
1945+
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
19451946
[Child Process]: child_process.html
19461947
[Cluster]: cluster.html
19471948
[debugger]: debugger.html
@@ -1953,6 +1954,5 @@ cases:
19531954
[Readable]: stream.html#stream_readable_streams
19541955
[Signal Events]: #process_signal_events
19551956
[Stream compatibility]: stream.html#stream_compatibility_with_older_node_js_versions
1956-
[Supported platforms]: https://github.com/nodejs/node/blob/master/BUILDING.md#supported-platforms-1
19571957
[TTY]: tty.html#tty_tty
19581958
[Writable]: stream.html#stream_writable_streams

0 commit comments

Comments
 (0)