Skip to content
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

doc: clarify ambiguous rdev description #34094

Merged
merged 0 commits into from Jul 1, 2020
Merged

Conversation

Trott
Copy link
Member

@Trott Trott commented Jun 28, 2020

Replace "is considered 'special'" with "represents a device". The latter
is more clear and is derived from the stat() man page. The former is
also derived from the man page, but is ambiguous because:

  • "considered" introduces doubt. Is it, or isn't it?
  • "special" is never defined. "represents a device" communicates more
    meaning.
  • "special" is in scare-quotes, introducing more doubt as to what
    exactly it means.

Refs: https://man7.org/linux/man-pages/man2/fstat.2.html

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines

@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system. labels Jun 28, 2020
@Trott
Copy link
Member Author

Trott commented Jun 29, 2020

@nodejs/documentation

@Trott Trott added the author ready PRs that have at least one approval, no pending requests for changes, and a CI started. label Jun 29, 2020
@Trott
Copy link
Member Author

Trott commented Jun 30, 2020

@nodejs/fs

@Trott
Copy link
Member Author

Trott commented Jul 1, 2020

@nodejs/collaborators Hoping this is not particularly controversial. Needs a second review.

@Trott
Copy link
Member Author

Trott commented Jul 1, 2020

Landed in 584fc7e

@Trott Trott merged commit 584fc7e into nodejs:master Jul 1, 2020
@Trott Trott requested a review from a team July 1, 2020 04:53
@Trott Trott deleted the considered-fs branch July 1, 2020 04:53
MylesBorins pushed a commit that referenced this pull request Jul 14, 2020
Replace "is considered 'special'" with "represents a device". The latter
is more clear and is derived from the stat() man page. The former is
also derived from the man page, but is ambiguous because:

* "considered" introduces doubt. Is it, or isn't it?
* "special" is never defined. "represents a device" communicates more
  meaning.
* "special" is in scare-quotes, introducing more doubt as to what
  exactly it means.

Refs: https://man7.org/linux/man-pages/man2/fstat.2.html

PR-URL: #34094
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
@MylesBorins MylesBorins mentioned this pull request Jul 14, 2020
MylesBorins pushed a commit that referenced this pull request Jul 16, 2020
Replace "is considered 'special'" with "represents a device". The latter
is more clear and is derived from the stat() man page. The former is
also derived from the man page, but is ambiguous because:

* "considered" introduces doubt. Is it, or isn't it?
* "special" is never defined. "represents a device" communicates more
  meaning.
* "special" is in scare-quotes, introducing more doubt as to what
  exactly it means.

Refs: https://man7.org/linux/man-pages/man2/fstat.2.html

PR-URL: #34094
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
addaleax pushed a commit that referenced this pull request Sep 22, 2020
Replace "is considered 'special'" with "represents a device". The latter
is more clear and is derived from the stat() man page. The former is
also derived from the man page, but is ambiguous because:

* "considered" introduces doubt. Is it, or isn't it?
* "special" is never defined. "represents a device" communicates more
  meaning.
* "special" is in scare-quotes, introducing more doubt as to what
  exactly it means.

Refs: https://man7.org/linux/man-pages/man2/fstat.2.html

PR-URL: #34094
Reviewed-By: Anna Henningsen <anna@addaleax.net>
Reviewed-By: Ujjwal Sharma <ryzokuken@disroot.org>
@codebytere codebytere mentioned this pull request Sep 28, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
author ready PRs that have at least one approval, no pending requests for changes, and a CI started. doc Issues and PRs related to the documentations. fs Issues and PRs related to the fs subsystem / file system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants