diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2008-08-19 14:13:11 -0400 |
---|---|---|
committer | Jens Axboe <jens.axboe@oracle.com> | 2008-10-09 02:56:03 -0400 |
commit | 710027a48ede75428cc68eaa8ae2269b1e356e2c (patch) | |
tree | 22cba18860b83b03613bad97c405fb5146a2d686 /block/blk-map.c | |
parent | 5b99c2ffa980528a197f26c7d876cceeccce8dd5 (diff) |
Add some block/ source files to the kernel-api docbook. Fix kernel-doc notation in them as needed. Fix changed function parameter names. Fix typos/spellos. In comments, change REQ_SPECIAL to REQ_TYPE_SPECIAL and REQ_BLOCK_PC to REQ_TYPE_BLOCK_PC.
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Jens Axboe <jens.axboe@oracle.com>
Diffstat (limited to 'block/blk-map.c')
-rw-r--r-- | block/blk-map.c | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/block/blk-map.c b/block/blk-map.c index af37e4ae62f5..ea1bf53929e4 100644 --- a/block/blk-map.c +++ b/block/blk-map.c | |||
@@ -85,17 +85,17 @@ static int __blk_rq_map_user(struct request_queue *q, struct request *rq, | |||
85 | } | 85 | } |
86 | 86 | ||
87 | /** | 87 | /** |
88 | * blk_rq_map_user - map user data to a request, for REQ_BLOCK_PC usage | 88 | * blk_rq_map_user - map user data to a request, for REQ_TYPE_BLOCK_PC usage |
89 | * @q: request queue where request should be inserted | 89 | * @q: request queue where request should be inserted |
90 | * @rq: request structure to fill | 90 | * @rq: request structure to fill |
91 | * @ubuf: the user buffer | 91 | * @ubuf: the user buffer |
92 | * @len: length of user data | 92 | * @len: length of user data |
93 | * | 93 | * |
94 | * Description: | 94 | * Description: |
95 | * Data will be mapped directly for zero copy io, if possible. Otherwise | 95 | * Data will be mapped directly for zero copy I/O, if possible. Otherwise |
96 | * a kernel bounce buffer is used. | 96 | * a kernel bounce buffer is used. |
97 | * | 97 | * |
98 | * A matching blk_rq_unmap_user() must be issued at the end of io, while | 98 | * A matching blk_rq_unmap_user() must be issued at the end of I/O, while |
99 | * still in process context. | 99 | * still in process context. |
100 | * | 100 | * |
101 | * Note: The mapped bio may need to be bounced through blk_queue_bounce() | 101 | * Note: The mapped bio may need to be bounced through blk_queue_bounce() |
@@ -154,7 +154,7 @@ unmap_rq: | |||
154 | EXPORT_SYMBOL(blk_rq_map_user); | 154 | EXPORT_SYMBOL(blk_rq_map_user); |
155 | 155 | ||
156 | /** | 156 | /** |
157 | * blk_rq_map_user_iov - map user data to a request, for REQ_BLOCK_PC usage | 157 | * blk_rq_map_user_iov - map user data to a request, for REQ_TYPE_BLOCK_PC usage |
158 | * @q: request queue where request should be inserted | 158 | * @q: request queue where request should be inserted |
159 | * @rq: request to map data to | 159 | * @rq: request to map data to |
160 | * @iov: pointer to the iovec | 160 | * @iov: pointer to the iovec |
@@ -162,10 +162,10 @@ EXPORT_SYMBOL(blk_rq_map_user); | |||
162 | * @len: I/O byte count | 162 | * @len: I/O byte count |
163 | * | 163 | * |
164 | * Description: | 164 | * Description: |
165 | * Data will be mapped directly for zero copy io, if possible. Otherwise | 165 | * Data will be mapped directly for zero copy I/O, if possible. Otherwise |
166 | * a kernel bounce buffer is used. | 166 | * a kernel bounce buffer is used. |
167 | * | 167 | * |
168 | * A matching blk_rq_unmap_user() must be issued at the end of io, while | 168 | * A matching blk_rq_unmap_user() must be issued at the end of I/O, while |
169 | * still in process context. | 169 | * still in process context. |
170 | * | 170 | * |
171 | * Note: The mapped bio may need to be bounced through blk_queue_bounce() | 171 | * Note: The mapped bio may need to be bounced through blk_queue_bounce() |
@@ -224,7 +224,7 @@ int blk_rq_map_user_iov(struct request_queue *q, struct request *rq, | |||
224 | * Description: | 224 | * Description: |
225 | * Unmap a rq previously mapped by blk_rq_map_user(). The caller must | 225 | * Unmap a rq previously mapped by blk_rq_map_user(). The caller must |
226 | * supply the original rq->bio from the blk_rq_map_user() return, since | 226 | * supply the original rq->bio from the blk_rq_map_user() return, since |
227 | * the io completion may have changed rq->bio. | 227 | * the I/O completion may have changed rq->bio. |
228 | */ | 228 | */ |
229 | int blk_rq_unmap_user(struct bio *bio) | 229 | int blk_rq_unmap_user(struct bio *bio) |
230 | { | 230 | { |
@@ -250,7 +250,7 @@ int blk_rq_unmap_user(struct bio *bio) | |||
250 | EXPORT_SYMBOL(blk_rq_unmap_user); | 250 | EXPORT_SYMBOL(blk_rq_unmap_user); |
251 | 251 | ||
252 | /** | 252 | /** |
253 | * blk_rq_map_kern - map kernel data to a request, for REQ_BLOCK_PC usage | 253 | * blk_rq_map_kern - map kernel data to a request, for REQ_TYPE_BLOCK_PC usage |
254 | * @q: request queue where request should be inserted | 254 | * @q: request queue where request should be inserted |
255 | * @rq: request to fill | 255 | * @rq: request to fill |
256 | * @kbuf: the kernel buffer | 256 | * @kbuf: the kernel buffer |