tjh.dev / kernel
Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux
fork atom

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: <Valdis.Kletnieks@vt.edu>
Signed-off-by: Mike Waychison <mikew@google.com>
Signed-off-by: Greg Kroah-Hartman <gregkh@suse.de>

authored by

Mike Waychison and committed by
Greg Kroah-Hartman 695cca87 3116aabc

+9 -9
+9 -9
Documentation/ABI/testing/sysfs-firmware-dmi
··· 14 14 15 15 DMI is structured as a large table of entries, where 16 16 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. 19 20 20 21 Some entries are required by the specification, but many 21 22 others are optional. In general though, users should 22 23 never expect to find a specific entry type on their 23 24 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. 25 26 26 27 Multiple entries of the same type are allowed. In order 27 28 to handle these duplicate entry types, each entry is ··· 68 67 and the two terminating nul characters. 69 68 type : The type of the entry. This value is the same 70 69 as found in the directory name. It indicates 71 - how the rest of the entry should be 72 - interpreted. 70 + how the rest of the entry should be interpreted. 73 71 instance: The instance ordinal of the entry for the 74 72 given type. This value is the same as found 75 73 in the parent directory name. 76 - position: The position of the entry within the entirety 77 - of the entirety. 74 + position: The ordinal position (zero-based) of the entry 75 + within the entirety of the DMI entry table. 78 76 79 77 === Entry Specialization === 80 78 81 79 Some entry types may have other information available in 82 - sysfs. 80 + sysfs. Not all types are specialized. 83 81 84 82 --- Type 15 - System Event Log --- 85 83 86 84 This entry allows the firmware to export a log of 87 85 events the system has taken. This information is 88 86 typically backed by nvram, but the implementation 89 - details are abstracted by this table. This entries data 87 + details are abstracted by this table. This entry's data 90 88 is exported in the directory: 91 89 92 90 /sys/firmware/dmi/entries/15-0/system_event_log