Skip to content

Commit 39ad5eb

Browse files
committed
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. PR-URL: nodejs/node#19004 Reviewed-By: Anna Henningsen <[email protected]> Reviewed-By: Colin Ihrig <[email protected]> Reviewed-By: Yuta Hiroto <[email protected]>
1 parent 01e2eba commit 39ad5eb

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
@@ -1394,7 +1394,7 @@ console.log(`This platform is ${process.platform}`);
13941394

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

13991399
## process.ppid
14001400
<!-- YAML
@@ -1921,6 +1921,7 @@ cases:
19211921
[`promise.catch()`]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise/catch
19221922
[`require.main`]: modules.html#modules_accessing_the_main_module
19231923
[`setTimeout(fn, 0)`]: timers.html#timers_settimeout_callback_delay_args
1924+
[Android building]: https://github.com/nodejs/node/blob/master/BUILDING.md#androidandroid-based-devices-eg-firefox-os
19241925
[Child Process]: child_process.html
19251926
[Cluster]: cluster.html
19261927
[debugger]: debugger.html
@@ -1932,6 +1933,5 @@ cases:
19321933
[Readable]: stream.html#stream_readable_streams
19331934
[Signal Events]: #process_signal_events
19341935
[Stream compatibility]: stream.html#stream_compatibility_with_older_node_js_versions
1935-
[Supported platforms]: https://github.com/nodejs/node/blob/master/BUILDING.md#supported-platforms-1
19361936
[TTY]: tty.html#tty_tty
19371937
[Writable]: stream.html#stream_writable_streams

0 commit comments

Comments
 (0)