diff options
author | David Fries <David@Fries.net> | 2014-01-15 23:29:25 -0500 |
---|---|---|
committer | Greg Kroah-Hartman <gregkh@linuxfoundation.org> | 2014-02-07 18:40:18 -0500 |
commit | b3be177a19f0f9e4f0deb473cef0e95e1254f2e9 (patch) | |
tree | e124f5b65942b7883fb2dcdc29e8e4ffca2625a7 /Documentation/w1/w1.netlink | |
parent | eb2c0da4ac2f4614b0bd3a1b6a0e9b82d0802e08 (diff) |
w1: format for DocBook and fixes
Switch the code documentation format style to DocBook format, enable
DocBook documentation generation, and fix some comments.
Signed-off-by: David Fries <David@Fries.net>
Acked-by: Evgeniy Polyakov <zbr@ioremap.net>
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
Diffstat (limited to 'Documentation/w1/w1.netlink')
-rw-r--r-- | Documentation/w1/w1.netlink | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/Documentation/w1/w1.netlink b/Documentation/w1/w1.netlink index f59a31965d50..927a52cc0519 100644 --- a/Documentation/w1/w1.netlink +++ b/Documentation/w1/w1.netlink | |||
@@ -5,8 +5,8 @@ Message types. | |||
5 | ============= | 5 | ============= |
6 | 6 | ||
7 | There are three types of messages between w1 core and userspace: | 7 | There are three types of messages between w1 core and userspace: |
8 | 1. Events. They are generated each time new master or slave device | 8 | 1. Events. They are generated each time a new master or slave device |
9 | found either due to automatic or requested search. | 9 | is found either due to automatic or requested search. |
10 | 2. Userspace commands. | 10 | 2. Userspace commands. |
11 | 3. Replies to userspace commands. | 11 | 3. Replies to userspace commands. |
12 | 12 | ||
@@ -131,7 +131,7 @@ of the w1_netlink_cmd structure and cn_msg.len will be equal to the sum | |||
131 | of the sizeof(struct w1_netlink_msg) and sizeof(struct w1_netlink_cmd). | 131 | of the sizeof(struct w1_netlink_msg) and sizeof(struct w1_netlink_cmd). |
132 | If reply is generated for master or root command (which do not have | 132 | If reply is generated for master or root command (which do not have |
133 | w1_netlink_cmd attached), reply will contain only cn_msg and w1_netlink_msg | 133 | w1_netlink_cmd attached), reply will contain only cn_msg and w1_netlink_msg |
134 | structires. | 134 | structures. |
135 | 135 | ||
136 | w1_netlink_msg.status field will carry positive error value | 136 | w1_netlink_msg.status field will carry positive error value |
137 | (EINVAL for example) or zero in case of success. | 137 | (EINVAL for example) or zero in case of success. |
@@ -160,7 +160,7 @@ procedure is started to select given device. | |||
160 | Then all requested in w1_netlink_msg operations are performed one by one. | 160 | Then all requested in w1_netlink_msg operations are performed one by one. |
161 | If command requires reply (like read command) it is sent on command completion. | 161 | If command requires reply (like read command) it is sent on command completion. |
162 | 162 | ||
163 | When all commands (w1_netlink_cmd) are processed muster device is unlocked | 163 | When all commands (w1_netlink_cmd) are processed master device is unlocked |
164 | and next w1_netlink_msg header processing started. | 164 | and next w1_netlink_msg header processing started. |
165 | 165 | ||
166 | 166 | ||