Skip to content

doc: clarify ambiguous rdev description - #34094

Merged
Trott merged 0 commit into
nodejs:masterfrom
Trott:considered-fs
Jul 1, 2020
Merged

doc: clarify ambiguous rdev description#34094
Trott merged 0 commit into
nodejs:masterfrom
Trott:considered-fs

Conversation

@Trott

Copy link
Copy Markdown
Member

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-botnodejs-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
Copy Markdown
MemberAuthor

@nodejs/documentation

@TrottTrott 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
Copy Markdown
MemberAuthor

@nodejs/fs

@Trott

Trott commented Jul 1, 2020

Copy link
Copy Markdown
MemberAuthor

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

@Trott

Trott commented Jul 1, 2020

Copy link
Copy Markdown
MemberAuthor

Landed in 584fc7e

@Trott
Trott merged commit 584fc7e into nodejs:masterJul 1, 2020
@Trott
Trott requested a review from a teamJuly 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>
@MylesBorinsMylesBorins 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>
@codebyterecodebytere mentioned this pull request Sep 28, 2020
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Labels

author readyPRs that have at least one approval, no pending requests for changes, and a CI started.docIssues and PRs related to the documentations.fsIssues and PRs related to the fs subsystem / file system.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants

@Trott@addaleax@ryzokuken@nodejs-github-bot