FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc: general improvements to os.md copy by jasnell · Pull Request #7124 · nodejs/node · GitHub

/ node Public

doc: general improvements to os.md copy - #7124

Closed
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:doc-os-copy
Closed

doc: general improvements to os.md copy#7124
jasnell wants to merge 1 commit into
nodejs:masterfrom
jasnell:doc-os-copy

Conversation

jasnell commented Jun 3, 2016

Copy link
Copy Markdown
Member
Checklist
  • documentation is changed or added
  • the commit message follows commit guidelines
Affected core subsystem(s)

doc (os)

Description of change

General improvements to os.md copy

@nodejs/documentation

jasnell added doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem. labels Jun 3, 2016
Comment thread doc/api/os.md Outdated

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Copy link
Copy Markdown
Member Author

Updated :-)

Comment thread doc/api/os.md Outdated

mscdex Jun 3, 2016
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

s/operating-system related/operating system-related/

jasnell commented Jun 3, 2016

Copy link
Copy Markdown
Member Author

Updated

Comment thread doc/api/os.md Outdated

mscdex Jun 3, 2016
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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

Copy link
Copy Markdown
Member Author

Updated! PTAL

Comment thread doc/api/os.md Outdated

Fishrock123 Jun 3, 2016
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

uname(3) should have a posix link like other such man page links now have in the docs.

e.g. in the fs docs.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

Man page references are automatically converted to links by the doctool, so there’s no real need for that.

jasnell commented Jun 6, 2016

Copy link
Copy Markdown
Member Author

ping @nodejs/documentation

Comment thread doc/api/os.md Outdated

mscdex Jun 6, 2016
edited
Loading

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

I've seen capitalization differing in various parts of all of the docs. Should we stick to capitals or no?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Choose a reason Spam Abuse Off Topic Outdated Duplicate Resolved Low Quality

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.

This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters. Learn more about bidirectional Unicode characters
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

doc Issues and PRs related to the documentations. os Issues and PRs related to the os subsystem.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants


Back | FazBrowse Home | New Git URL