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

Configure Feed

Select the types of activity you want to include in your feed.

SUNRPC: xdr.h: fix all kernel-doc warnings

Correct a function parameter name (s/page/folio/) and add function
return value sections for multiple functions to eliminate
kernel-doc warnings:

Warning: include/linux/sunrpc/xdr.h:298 function parameter 'folio' not
described in 'xdr_set_scratch_folio'
Warning: include/linux/sunrpc/xdr.h:337 No description found for return
value of 'xdr_stream_remaining'
Warning: include/linux/sunrpc/xdr.h:357 No description found for return
value of 'xdr_align_size'
Warning: include/linux/sunrpc/xdr.h:374 No description found for return
value of 'xdr_pad_size'
Warning: include/linux/sunrpc/xdr.h:387 No description found for return
value of 'xdr_stream_encode_item_present'

Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Signed-off-by: Chuck Lever <chuck.lever@oracle.com>

authored by

Randy Dunlap and committed by
Chuck Lever 3603bf99 2239535f

+24 -24
+24 -24
include/linux/sunrpc/xdr.h
··· 290 290 /** 291 291 * xdr_set_scratch_folio - Attach a scratch buffer for decoding data 292 292 * @xdr: pointer to xdr_stream struct 293 - * @page: an anonymous folio 293 + * @folio: an anonymous folio 294 294 * 295 295 * See xdr_set_scratch_buffer(). 296 296 */ ··· 330 330 * xdr_stream_remaining - Return the number of bytes remaining in the stream 331 331 * @xdr: pointer to struct xdr_stream 332 332 * 333 - * Return value: 333 + * Returns: 334 334 * Number of bytes remaining in @xdr before xdr->end 335 335 */ 336 336 static inline size_t ··· 350 350 * xdr_align_size - Calculate padded size of an object 351 351 * @n: Size of an object being XDR encoded (in bytes) 352 352 * 353 - * Return value: 353 + * Returns: 354 354 * Size (in bytes) of the object including xdr padding 355 355 */ 356 356 static inline size_t ··· 368 368 * This implementation avoids the need for conditional 369 369 * branches or modulo division. 370 370 * 371 - * Return value: 371 + * Returns: 372 372 * Size (in bytes) of the needed XDR pad 373 373 */ 374 374 static inline size_t xdr_pad_size(size_t n) ··· 380 380 * xdr_stream_encode_item_present - Encode a "present" list item 381 381 * @xdr: pointer to xdr_stream 382 382 * 383 - * Return values: 383 + * Returns: 384 384 * On success, returns length in bytes of XDR buffer consumed 385 385 * %-EMSGSIZE on XDR buffer overflow 386 386 */ ··· 399 399 * xdr_stream_encode_item_absent - Encode a "not present" list item 400 400 * @xdr: pointer to xdr_stream 401 401 * 402 - * Return values: 402 + * Returns: 403 403 * On success, returns length in bytes of XDR buffer consumed 404 404 * %-EMSGSIZE on XDR buffer overflow 405 405 */ ··· 419 419 * @p: address in a buffer into which to encode 420 420 * @n: boolean value to encode 421 421 * 422 - * Return value: 422 + * Returns: 423 423 * Address of item following the encoded boolean 424 424 */ 425 425 static inline __be32 *xdr_encode_bool(__be32 *p, u32 n) ··· 433 433 * @xdr: pointer to xdr_stream 434 434 * @n: boolean value to encode 435 435 * 436 - * Return values: 436 + * Returns: 437 437 * On success, returns length in bytes of XDR buffer consumed 438 438 * %-EMSGSIZE on XDR buffer overflow 439 439 */ ··· 453 453 * @xdr: pointer to xdr_stream 454 454 * @n: integer to encode 455 455 * 456 - * Return values: 456 + * Returns: 457 457 * On success, returns length in bytes of XDR buffer consumed 458 458 * %-EMSGSIZE on XDR buffer overflow 459 459 */ ··· 474 474 * @xdr: pointer to xdr_stream 475 475 * @n: integer to encode 476 476 * 477 - * Return values: 477 + * Returns: 478 478 * On success, returns length in bytes of XDR buffer consumed 479 479 * %-EMSGSIZE on XDR buffer overflow 480 480 */ ··· 495 495 * @xdr: pointer to xdr_stream 496 496 * @n: 64-bit integer to encode 497 497 * 498 - * Return values: 498 + * Returns: 499 499 * On success, returns length in bytes of XDR buffer consumed 500 500 * %-EMSGSIZE on XDR buffer overflow 501 501 */ ··· 517 517 * @ptr: pointer to void pointer 518 518 * @len: size of object 519 519 * 520 - * Return values: 520 + * Returns: 521 521 * On success, returns length in bytes of XDR buffer consumed 522 522 * %-EMSGSIZE on XDR buffer overflow 523 523 */ ··· 542 542 * @ptr: pointer to opaque data object 543 543 * @len: size of object pointed to by @ptr 544 544 * 545 - * Return values: 545 + * Returns: 546 546 * On success, returns length in bytes of XDR buffer consumed 547 547 * %-EMSGSIZE on XDR buffer overflow 548 548 */ ··· 563 563 * @ptr: pointer to opaque data object 564 564 * @len: size of object pointed to by @ptr 565 565 * 566 - * Return values: 566 + * Returns: 567 567 * On success, returns length in bytes of XDR buffer consumed 568 568 * %-EMSGSIZE on XDR buffer overflow 569 569 */ ··· 585 585 * @array: array of integers 586 586 * @array_size: number of elements in @array 587 587 * 588 - * Return values: 588 + * Returns: 589 589 * On success, returns length in bytes of XDR buffer consumed 590 590 * %-EMSGSIZE on XDR buffer overflow 591 591 */ ··· 608 608 * xdr_item_is_absent - symbolically handle XDR discriminators 609 609 * @p: pointer to undecoded discriminator 610 610 * 611 - * Return values: 611 + * Returns: 612 612 * %true if the following XDR item is absent 613 613 * %false if the following XDR item is present 614 614 */ ··· 621 621 * xdr_item_is_present - symbolically handle XDR discriminators 622 622 * @p: pointer to undecoded discriminator 623 623 * 624 - * Return values: 624 + * Returns: 625 625 * %true if the following XDR item is present 626 626 * %false if the following XDR item is absent 627 627 */ ··· 635 635 * @xdr: pointer to xdr_stream 636 636 * @ptr: pointer to a u32 in which to store the result 637 637 * 638 - * Return values: 638 + * Returns: 639 639 * %0 on success 640 640 * %-EBADMSG on XDR buffer overflow 641 641 */ ··· 656 656 * @xdr: pointer to xdr_stream 657 657 * @ptr: location to store integer 658 658 * 659 - * Return values: 659 + * Returns: 660 660 * %0 on success 661 661 * %-EBADMSG on XDR buffer overflow 662 662 */ ··· 677 677 * @xdr: pointer to xdr_stream 678 678 * @ptr: location to store integer 679 679 * 680 - * Return values: 680 + * Returns: 681 681 * %0 on success 682 682 * %-EBADMSG on XDR buffer overflow 683 683 */ ··· 698 698 * @xdr: pointer to xdr_stream 699 699 * @ptr: location to store 64-bit integer 700 700 * 701 - * Return values: 701 + * Returns: 702 702 * %0 on success 703 703 * %-EBADMSG on XDR buffer overflow 704 704 */ ··· 720 720 * @ptr: location to store data 721 721 * @len: size of buffer pointed to by @ptr 722 722 * 723 - * Return values: 723 + * Returns: 724 724 * %0 on success 725 725 * %-EBADMSG on XDR buffer overflow 726 726 */ ··· 746 746 * on @xdr. It is therefore expected that the object it points to should 747 747 * be processed immediately. 748 748 * 749 - * Return values: 749 + * Returns: 750 750 * On success, returns size of object stored in *@ptr 751 751 * %-EBADMSG on XDR buffer overflow 752 752 * %-EMSGSIZE if the size of the object would exceed @maxlen ··· 777 777 * @array: location to store the integer array or NULL 778 778 * @array_size: number of elements to store 779 779 * 780 - * Return values: 780 + * Returns: 781 781 * On success, returns number of elements stored in @array 782 782 * %-EBADMSG on XDR buffer overflow 783 783 * %-EMSGSIZE if the size of the array exceeds @array_size