doc: general improvements to os.md copy #7124
Conversation
jasnell
added
doc
doc/api/os.md
Outdated
There was a problem hiding this comment.
btw, from proc(5) for Linux:
user (1) Time spent in user mode.
nice (2) Time spent in user mode with low priority (nice).
system (3) Time spent in system mode.
idle (4) Time spent in the idle task. This value should be USER_HZ times the second entry in the /proc/uptime pseudo-file.
iowait (since Linux 2.5.41)
(5) Time waiting for I/O to complete.
irq (since Linux 2.6.0-test4)
(6) Time servicing interrupts.
softirq (since Linux 2.6.0-test4)
(7) Time servicing softirqs.
[…]
I’d expect these values to mean similar things on other OS, so it might be worth using descriptions based on these?
|
Updated :-) |
doc/api/os.md
Outdated
There was a problem hiding this comment.
s/operating-system related/operating system-related/
|
Updated |
doc/api/os.md
Outdated
There was a problem hiding this comment.
According to the current list of valid operating systems in configure and the name changes in node.gyp, this list should be:
- aix
- android
- darwin
- freebsd
- linux
- openbsd
- sunos
- win32
|
Updated! PTAL |
doc/api/os.md
Outdated
There was a problem hiding this comment.
uname(3) should have a posix link like other such man page links now have in the docs.
e.g. in the fs docs.
There was a problem hiding this comment.
Man page references are automatically converted to links by the doctool, so there’s no real need for that.
|
ping @nodejs/documentation |
doc/api/os.md
Outdated
There was a problem hiding this comment.
I've seen capitalization differing in various parts of all of the docs. Should we stick to capitals or no?
There was a problem hiding this comment.
I'm planning to make a second pass to improve the consistency of argument types. For now I'm focusing primarily on making sure that arguments are even listed in the first place.
|
Updated! |
doc/api/os.md
Outdated
There was a problem hiding this comment.
s/operating-system specific/operating system-specific/
|
@mscdex ... updated! |
doc/api/os.md
Outdated
|
Updated |
|
LGTM |
PR-URL: #7124 Reviewed-By: Brian White <[email protected]>
|
Landed in ecc48a1. Thank you! |
PR-URL: #7124 Reviewed-By: Brian White <[email protected]>
PR-URL: #7124 Reviewed-By: Brian White <[email protected]>
6 participants
Checklist
Affected core subsystem(s)
doc (os)
Description of change
General improvements to os.md copy
@nodejs/documentation