Commit 8ebf9756 authored by Randy Dunlap's avatar Randy Dunlap Committed by Linus Torvalds
Browse files

block: fix kernel-doc in recent block/ changes 



Fix kernel-doc warnings in recently changed block/ source code.

Signed-off-by: default avatarRandy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: default avatarLinus Torvalds <torvalds@linux-foundation.org>
parent 4b4f1d01

block/blk-core.c

+11 −10
Original line number Diff line number Diff line
@@ -884,9 +884,10 @@ EXPORT_SYMBOL(blk_get_request); 


/**

 * blk_make_request - given a bio, allocate a corresponding struct request.

 *

 * @q: target request queue

 * @bio:  The bio describing the memory mappings that will be submitted for IO.

 *        It may be a chained-bio properly constructed by block/bio layer.

 * @gfp_mask: gfp flags to be used for memory allocation

 *

 * blk_make_request is the parallel of generic_make_request for BLOCK_PC

 * type commands. Where the struct request needs to be farther initialized by
@@ -1872,14 +1873,14 @@ EXPORT_SYMBOL(blk_fetch_request); 


/**

 * blk_update_request - Special helper function for request stacking drivers

 * @rq:	      the request being processed

 * @req:      the request being processed

 * @error:    %0 for success, < %0 for error

 * @nr_bytes: number of bytes to complete @rq

 * @nr_bytes: number of bytes to complete @req

 *

 * Description:

 *     Ends I/O on a number of bytes attached to @rq, but doesn't complete

 *     the request structure even if @rq doesn't have leftover.

 *     If @rq has leftover, sets it up for the next range of segments.

 *     Ends I/O on a number of bytes attached to @req, but doesn't complete

 *     the request structure even if @req doesn't have leftover.

 *     If @req has leftover, sets it up for the next range of segments.

 *

 *     This special helper function is only for request stacking drivers

 *     (e.g. request-based dm) so that they can handle partial completion.
@@ -2145,7 +2146,7 @@ EXPORT_SYMBOL_GPL(blk_end_request); 
/**

 * blk_end_request_all - Helper function for drives to finish the request.

 * @rq: the request to finish

 * @err: %0 for success, < %0 for error

 * @error: %0 for success, < %0 for error

 *

 * Description:

 *     Completely finish @rq.
@@ -2166,7 +2167,7 @@ EXPORT_SYMBOL_GPL(blk_end_request_all); 
/**

 * blk_end_request_cur - Helper function to finish the current request chunk.

 * @rq: the request to finish the current chunk for

 * @err: %0 for success, < %0 for error

 * @error: %0 for success, < %0 for error

 *

 * Description:

 *     Complete the current consecutively mapped chunk from @rq.
@@ -2203,7 +2204,7 @@ EXPORT_SYMBOL_GPL(__blk_end_request); 
/**

 * __blk_end_request_all - Helper function for drives to finish the request.

 * @rq: the request to finish

 * @err: %0 for success, < %0 for error

 * @error: %0 for success, < %0 for error

 *

 * Description:

 *     Completely finish @rq.  Must be called with queue lock held.
@@ -2224,7 +2225,7 @@ EXPORT_SYMBOL_GPL(__blk_end_request_all); 
/**

 * __blk_end_request_cur - Helper function to finish the current request chunk.

 * @rq: the request to finish the current chunk for

 * @err: %0 for success, < %0 for error

 * @error: %0 for success, < %0 for error

 *

 * Description:

 *     Complete the current consecutively mapped chunk from @rq.  Must

block/blk-settings.c

+3 −3
Original line number Diff line number Diff line
@@ -343,7 +343,7 @@ EXPORT_SYMBOL(blk_queue_physical_block_size); 
/**

 * blk_queue_alignment_offset - set physical block alignment offset

 * @q:	the request queue for the device

 * @alignment:	alignment offset in bytes

 * @offset: alignment offset in bytes

 *

 * Description:

 *   Some devices are naturally misaligned to compensate for things like
@@ -362,7 +362,7 @@ EXPORT_SYMBOL(blk_queue_alignment_offset); 
/**

 * blk_queue_io_min - set minimum request size for the queue

 * @q:	the request queue for the device

 * @io_min:  smallest I/O size in bytes

 * @min:  smallest I/O size in bytes

 *

 * Description:

 *   Some devices have an internal block size bigger than the reported
@@ -385,7 +385,7 @@ EXPORT_SYMBOL(blk_queue_io_min); 
/**

 * blk_queue_io_opt - set optimal request size for the queue

 * @q:	the request queue for the device

 * @io_opt:  optimal request size in bytes

 * @opt:  optimal request size in bytes

 *

 * Description:

 *   Drivers can call this function to set the preferred I/O request