diff options
author | Mike Waychison <mikew@google.com> | 2011-03-18 19:50:03 -0400 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@suse.de> | 2011-04-19 19:45:51 -0400 |
commit | 695cca8763078c743417886e80af8ccb78bec9f2 (patch) | |
tree | c2adddf403ae456aa04575d8c680e5cdedeaac96 /Documentation/ABI | |
parent | 3116aabc81ccfeeb73f183ed8b1e3031520d1e59 (diff) |
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>
Diffstat (limited to 'Documentation/ABI')
-rw-r--r-- | Documentation/ABI/testing/sysfs-firmware-dmi | 18 |
1 files changed, 9 insertions, 9 deletions
diff --git a/Documentation/ABI/testing/sysfs-firmware-dmi b/Documentation/ABI/testing/sysfs-firmware-dmi index ba9da9503c23..c78f9ab01e56 100644 --- a/Documentation/ABI/testing/sysfs-firmware-dmi +++ b/Documentation/ABI/testing/sysfs-firmware-dmi | |||
@@ -14,14 +14,15 @@ Description: | |||
14 | 14 | ||
15 | DMI is structured as a large table of entries, where | 15 | DMI is structured as a large table of entries, where |
16 | each entry has a common header indicating the type and | 16 | each entry has a common header indicating the type and |
17 | length of the entry, as well as 'handle' that is | 17 | length of the entry, as well as a firmware-provided |
18 | supposed to be unique amongst all entries. | 18 | 'handle' that is supposed to be unique amongst all |
19 | entries. | ||
19 | 20 | ||
20 | Some entries are required by the specification, but many | 21 | Some entries are required by the specification, but many |
21 | others are optional. In general though, users should | 22 | others are optional. In general though, users should |
22 | never expect to find a specific entry type on their | 23 | never expect to find a specific entry type on their |
23 | system unless they know for certain what their firmware | 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 | Multiple entries of the same type are allowed. In order | 27 | Multiple entries of the same type are allowed. In order |
27 | to handle these duplicate entry types, each entry is | 28 | to handle these duplicate entry types, each entry is |
@@ -67,25 +68,24 @@ Description: | |||
67 | and the two terminating nul characters. | 68 | and the two terminating nul characters. |
68 | type : The type of the entry. This value is the same | 69 | type : The type of the entry. This value is the same |
69 | as found in the directory name. It indicates | 70 | as found in the directory name. It indicates |
70 | how the rest of the entry should be | 71 | how the rest of the entry should be interpreted. |
71 | interpreted. | ||
72 | instance: The instance ordinal of the entry for the | 72 | instance: The instance ordinal of the entry for the |
73 | given type. This value is the same as found | 73 | given type. This value is the same as found |
74 | in the parent directory name. | 74 | in the parent directory name. |
75 | position: The position of the entry within the entirety | 75 | position: The ordinal position (zero-based) of the entry |
76 | of the entirety. | 76 | within the entirety of the DMI entry table. |
77 | 77 | ||
78 | === Entry Specialization === | 78 | === Entry Specialization === |
79 | 79 | ||
80 | Some entry types may have other information available in | 80 | Some entry types may have other information available in |
81 | sysfs. | 81 | sysfs. Not all types are specialized. |
82 | 82 | ||
83 | --- Type 15 - System Event Log --- | 83 | --- Type 15 - System Event Log --- |
84 | 84 | ||
85 | This entry allows the firmware to export a log of | 85 | This entry allows the firmware to export a log of |
86 | events the system has taken. This information is | 86 | events the system has taken. This information is |
87 | typically backed by nvram, but the implementation | 87 | 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 |
89 | is exported in the directory: | 89 | is exported in the directory: |
90 | 90 | ||
91 | /sys/firmware/dmi/entries/15-0/system_event_log | 91 | /sys/firmware/dmi/entries/15-0/system_event_log |