Skip to content

Commit 695cca8

Browse files
waychgregkh
authored andcommitted
firmware: Fix grammar in sysfs-firmware-dmi doc
Fix the grammar in describing the position attribute of DMI entries in the dmi-sysfs module. While here, make a couple other small clarifying fixups to the docs. Reported-by: <[email protected]> Signed-off-by: Mike Waychison <[email protected]> Signed-off-by: Greg Kroah-Hartman <[email protected]>
1 parent 3116aab commit 695cca8

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

Documentation/ABI/testing/sysfs-firmware-dmi

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,15 @@ Description:
1414

1515
DMI is structured as a large table of entries, where
1616
each entry has a common header indicating the type and
17-
length of the entry, as well as 'handle' that is
18-
supposed to be unique amongst all entries.
17+
length of the entry, as well as a firmware-provided
18+
'handle' that is supposed to be unique amongst all
19+
entries.
1920

2021
Some entries are required by the specification, but many
2122
others are optional. In general though, users should
2223
never expect to find a specific entry type on their
2324
system unless they know for certain what their firmware
24-
is doing. Machine to machine will vary.
25+
is doing. Machine to machine experiences will vary.
2526

2627
Multiple entries of the same type are allowed. In order
2728
to handle these duplicate entry types, each entry is
@@ -67,25 +68,24 @@ Description:
6768
and the two terminating nul characters.
6869
type : The type of the entry. This value is the same
6970
as found in the directory name. It indicates
70-
how the rest of the entry should be
71-
interpreted.
71+
how the rest of the entry should be interpreted.
7272
instance: The instance ordinal of the entry for the
7373
given type. This value is the same as found
7474
in the parent directory name.
75-
position: The position of the entry within the entirety
76-
of the entirety.
75+
position: The ordinal position (zero-based) of the entry
76+
within the entirety of the DMI entry table.
7777

7878
=== Entry Specialization ===
7979

8080
Some entry types may have other information available in
81-
sysfs.
81+
sysfs. Not all types are specialized.
8282

8383
--- Type 15 - System Event Log ---
8484

8585
This entry allows the firmware to export a log of
8686
events the system has taken. This information is
8787
typically backed by nvram, but the implementation
88-
details are abstracted by this table. This entries data
88+
details are abstracted by this table. This entry's data
8989
is exported in the directory:
9090

9191
/sys/firmware/dmi/entries/15-0/system_event_log

0 commit comments

Comments
 (0)