GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — doc: general improvements to os.md copy by jasnell · Pull Request #7124 · nodejs/node

Conversation

@jasnell

@jasnell 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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@jasnell jasnell added doc Issues and PRs related to Node.js documentation. os Issues and PRs related to the os subsystem. labels Jun 3, 2016
addaleax
addaleax reviewed Jun 3, 2016
View reviewed changes
Comment thread doc/api/os.md Outdated

@addaleax addaleax Jun 3, 2016

Copy link
Copy Markdown
Member

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?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
jasnell reacted with thumbs up emoji
All reactions
  • 👍 1 reaction
@jasnell

jasnell commented Jun 3, 2016

Copy link
Copy Markdown
Member Author

Updated :-)
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
mscdex
mscdex reviewed Jun 3, 2016
View reviewed changes
Comment thread doc/api/os.md Outdated

@mscdex mscdex Jun 3, 2016 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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/

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@jasnell

jasnell commented Jun 3, 2016

Copy link
Copy Markdown
Member Author

Updated
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
mscdex
mscdex reviewed Jun 3, 2016
View reviewed changes
Comment thread doc/api/os.md Outdated

@mscdex mscdex Jun 3, 2016 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@jasnell
jasnell force-pushed the doc-os-copy branch from 2a823de to 869d64c Compare June 3, 2016 15:53
@jasnell

jasnell commented Jun 3, 2016

Copy link
Copy Markdown
Member Author

Updated! PTAL
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
Fishrock123
Fishrock123 reviewed Jun 3, 2016
View reviewed changes
Comment thread doc/api/os.md Outdated

@Fishrock123 Fishrock123 Jun 3, 2016 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@addaleax addaleax Jun 3, 2016

Copy link
Copy Markdown
Member

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@jasnell

jasnell commented Jun 6, 2016

Copy link
Copy Markdown
Member Author

ping @nodejs/documentation
All reactions

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
mscdex
mscdex reviewed Jun 6, 2016
View reviewed changes
Comment thread doc/api/os.md Outdated

@mscdex mscdex Jun 6, 2016 •
edited
Loading

Uh oh!

There was an error while loading. Please reload this page.

Copy link
Copy Markdown
Contributor

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?

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions

@jasnell jasnell Jun 9, 2016

Copy link
Copy Markdown
Member Author

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.

Sorry, something went wrong.

Uh oh!

There was an error while loading. Please reload this page.
All reactions
@jasnell
jasnell force-pushed the doc-os-copy branch from 869d64c to 210c626 Compare June 9, 2016 17:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Uh oh!

There was an error while loading. Please reload this page.

Assignees

No one assigned

Labels

doc Issues and PRs related to Node.js documentation. os Issues and PRs related to the os subsystem.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Uh oh!

There was an error while loading. Please reload this page.

6 participants

@jasnell @mscdex @bnoordhuis @addaleax @Fishrock123 @MylesBorins
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
You are visitor 01402503 — GeezerVison does not store the pages you look up.
Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.