Uh oh!
There was an error while loading. Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork 34.2k
doc: general improvements to os.md copy#7124
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Uh oh!
There was an error while loading. Please reload this page.
Conversation
doc/api/os.md Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
jasnell commented Jun 3, 2016
Updated :-) |
doc/api/os.md Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/operating-system related/operating system-related/
jasnell commented Jun 3, 2016
Updated |
doc/api/os.md Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
jasnell commented Jun 3, 2016
Updated! PTAL |
doc/api/os.md Outdated
Fishrock123Jun 3, 2016 • edited
Loading Uh oh!
There was an error while loading. Please reload this page.
edited
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Man page references are automatically converted to links by the doctool, so there’s no real need for that.
jasnell commented Jun 6, 2016
ping @nodejs/documentation |
doc/api/os.md Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
jasnell commented Jun 9, 2016
Updated! |
doc/api/os.md Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/operating-system specific/operating system-specific/
jasnell commented Jun 21, 2016
@mscdex ... updated! |
doc/api/os.md Outdated
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/on/for/
jasnell commented Jun 21, 2016
Updated |
mscdex commented Jun 21, 2016
LGTM |
PR-URL: #7124 Reviewed-By: Brian White <[email protected]>
jasnell commented Jun 21, 2016
Landed in ecc48a1. Thank you! |
PR-URL: #7124 Reviewed-By: Brian White <[email protected]>
PR-URL: #7124 Reviewed-By: Brian White <[email protected]>
Checklist
Affected core subsystem(s)
doc (os)
Description of change
General improvements to os.md copy
@nodejs/documentation