Skip to content

Commit

Permalink
doc: clarify ambiguous rdev description
Browse files Browse the repository at this point in the history
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 <[email protected]>
Reviewed-By: Ujjwal Sharma <[email protected]>
  • Loading branch information
Trott committed Jul 1, 2020
1 parent 31d6d9d commit 584fc7e
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion doc/api/fs.md
Original file line number Diff line number Diff line change
Expand Up @@ -888,7 +888,7 @@ The numeric group identifier of the group that owns the file (POSIX).

* {number|bigint}

A numeric device identifier if the file is considered "special".
A numeric device identifier if the file represents a device.

### `stats.size`

Expand Down

0 comments on commit 584fc7e

Please sign in to comment.