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

drm: Fix kerneldoc for "Returns" section

The blank line between title "Returns:" and detail description is not
allowed, otherwise the title will goes under the description block in
generated .html file after running `make htmldocs`.

There are a few examples for current kerneldoc at [1][2][3].

v2:
- use Link tag with stable URLs

Signed-off-by: renjun wang <renjunw0@foxmail.com>
Link: https://www.kernel.org/doc/html/v6.10/gpu/drm-kms.html#c.drm_crtc_commit_wait # 1
Link: https://www.kernel.org/doc/html/v6.10/gpu/drm-kms.html#c.drm_atomic_get_crtc_state # 2
Link: https://www.kernel.org/doc/html/v6.10/gpu/i915.html#c.i915_vma_pin_fence # 3
Reviewed-by: Thomas Zimmermann <tzimmermann@suse.de>
Signed-off-by: Thomas Zimmermann <tzimmermann@suse.de>
Link: https://patchwork.freedesktop.org/patch/msgid/tencent_37A873672B5CD20DECAF99DEDAC5E45C3106@qq.com

authored by

renjun wang and committed by
Thomas Zimmermann
22bc22cc cf4d37b8

+2 -31
-4
drivers/gpu/drm/display/drm_dp_mst_topology.c
··· 5569 5569 * drm_dp_atomic_release_time_slots() 5570 5570 * 5571 5571 * Returns: 5572 - * 5573 5572 * 0 if the new state is valid, negative error code otherwise. 5574 5573 */ 5575 5574 int drm_dp_mst_atomic_check(struct drm_atomic_state *state) ··· 5605 5606 * topology object. 5606 5607 * 5607 5608 * RETURNS: 5608 - * 5609 5609 * The MST topology state or error pointer. 5610 5610 */ 5611 5611 struct drm_dp_mst_topology_state *drm_atomic_get_mst_topology_state(struct drm_atomic_state *state, ··· 5624 5626 * topology object. 5625 5627 * 5626 5628 * Returns: 5627 - * 5628 5629 * The old MST topology state, or NULL if there's no topology state for this MST mgr 5629 5630 * in the global atomic state 5630 5631 */ ··· 5648 5651 * topology object. 5649 5652 * 5650 5653 * Returns: 5651 - * 5652 5654 * The new MST topology state, or NULL if there's no topology state for this MST mgr 5653 5655 * in the global atomic state 5654 5656 */
-6
drivers/gpu/drm/drm_atomic.c
··· 63 63 * hardware and flipped to. 64 64 * 65 65 * Returns: 66 - * 67 66 * 0 on success, a negative error code otherwise. 68 67 */ 69 68 int drm_crtc_commit_wait(struct drm_crtc_commit *commit) ··· 336 337 * not created by userspace through an IOCTL call. 337 338 * 338 339 * Returns: 339 - * 340 340 * Either the allocated state or the error code encoded into the pointer. When 341 341 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the 342 342 * entire atomic sequence must be restarted. All other errors are fatal. ··· 516 518 * is consistent. 517 519 * 518 520 * Returns: 519 - * 520 521 * Either the allocated state or the error code encoded into the pointer. When 521 522 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the 522 523 * entire atomic sequence must be restarted. All other errors are fatal. ··· 825 828 * object lock to make sure that the state is consistent. 826 829 * 827 830 * RETURNS: 828 - * 829 831 * Either the allocated state or the error code encoded into a pointer. 830 832 */ 831 833 struct drm_private_state * ··· 1057 1061 * make sure that the state is consistent. 1058 1062 * 1059 1063 * Returns: 1060 - * 1061 1064 * Either the allocated state or the error code encoded into the pointer. When 1062 1065 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the 1063 1066 * entire atomic sequence must be restarted. All other errors are fatal. ··· 1164 1169 * state is consistent. 1165 1170 * 1166 1171 * Returns: 1167 - * 1168 1172 * Either the allocated state or the error code encoded into the pointer. When 1169 1173 * the error is EDEADLK then the w/w mutex code has detected a deadlock and the 1170 1174 * entire atomic sequence must be restarted.
-2
drivers/gpu/drm/drm_atomic_helper.c
··· 2266 2266 * automatically. 2267 2267 * 2268 2268 * Returns: 2269 - * 2270 2269 * 0 on success. -EBUSY when userspace schedules nonblocking commits too fast, 2271 2270 * -ENOMEM on allocation failures and -EINTR when a signal is pending. 2272 2271 */ ··· 3008 3009 * don't pass the right state structures to the callbacks. 3009 3010 * 3010 3011 * Returns: 3011 - * 3012 3012 * Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the 3013 3013 * waiting for the previous commits has been interrupted. 3014 3014 */
-7
drivers/gpu/drm/drm_file.c
··· 347 347 * resources for it. It also calls the &drm_driver.open driver callback. 348 348 * 349 349 * RETURNS: 350 - * 351 350 * 0 on success or negative errno value on failure. 352 351 */ 353 352 int drm_open(struct inode *inode, struct file *filp) ··· 405 406 * in-kernel DRM client. 406 407 * 407 408 * RETURNS: 408 - * 409 409 * Always succeeds and returns 0. 410 410 */ 411 411 int drm_release(struct inode *inode, struct file *filp) ··· 475 477 * then restores the active in-kernel DRM client. 476 478 * 477 479 * RETURNS: 478 - * 479 480 * Always succeeds and returns 0. 480 481 */ 481 482 int drm_release_noglobal(struct inode *inode, struct file *filp) ··· 517 520 * safety. 518 521 * 519 522 * RETURNS: 520 - * 521 523 * Number of bytes read (always aligned to full events, and can be 0) or a 522 524 * negative error code on failure. 523 525 */ ··· 602 606 * See also drm_read(). 603 607 * 604 608 * RETURNS: 605 - * 606 609 * Mask of POLL flags indicating the current status of the file. 607 610 */ 608 611 __poll_t drm_poll(struct file *filp, struct poll_table_struct *wait) ··· 639 644 * already hold &drm_device.event_lock. 640 645 * 641 646 * RETURNS: 642 - * 643 647 * 0 on success or a negative error code on failure. 644 648 */ 645 649 int drm_event_reserve_init_locked(struct drm_device *dev, ··· 680 686 * drm_event_reserve_init_locked() instead. 681 687 * 682 688 * RETURNS: 683 - * 684 689 * 0 on success or a negative error code on failure. 685 690 */ 686 691 int drm_event_reserve_init(struct drm_device *dev,
+2 -5
drivers/gpu/drm/drm_gem.c
··· 689 689 * For a single handle lookup, use drm_gem_object_lookup(). 690 690 * 691 691 * Returns: 692 - * 693 692 * @objs filled in with GEM object pointers. Returned GEM objects need to be 694 693 * released with drm_gem_object_put(). -ENOENT is returned on a lookup 695 694 * failure. 0 is returned on success. ··· 736 737 * @filp: DRM file private date 737 738 * @handle: userspace handle 738 739 * 739 - * Returns: 740 + * If looking up an array of handles, use drm_gem_objects_lookup(). 740 741 * 742 + * Returns: 741 743 * A reference to the object named by the handle if such exists on @filp, NULL 742 744 * otherwise. 743 - * 744 - * If looking up an array of handles, use drm_gem_objects_lookup(). 745 745 */ 746 746 struct drm_gem_object * 747 747 drm_gem_object_lookup(struct drm_file *filp, u32 handle) ··· 761 763 * @timeout: timeout value in jiffies or zero to return immediately 762 764 * 763 765 * Returns: 764 - * 765 766 * Returns -ERESTARTSYS if interrupted, 0 if the wait timed out, or 766 767 * greater than 0 on success. 767 768 */
-1
drivers/gpu/drm/drm_modes.c
··· 539 539 * to reach those resolutions. 540 540 * 541 541 * Returns: 542 - * 543 542 * A pointer to the mode, allocated with drm_mode_create(). Returns NULL 544 543 * on error. 545 544 */
-1
drivers/gpu/drm/drm_rect.c
··· 85 85 * factors from @src to @dst. 86 86 * 87 87 * RETURNS: 88 - * 89 88 * %true if rectangle @dst is still visible after being clipped, 90 89 * %false otherwise. 91 90 */
-2
drivers/gpu/drm/drm_vblank.c
··· 686 686 * drm_atomic_helper_calc_timestamping_constants(). 687 687 * 688 688 * Returns: 689 - * 690 689 * Returns true on success, and false on failure, i.e. when no accurate 691 690 * timestamp could be acquired. 692 691 */ ··· 830 831 * drm_atomic_helper_calc_timestamping_constants(). 831 832 * 832 833 * Returns: 833 - * 834 834 * Returns true on success, and false on failure, i.e. when no accurate 835 835 * timestamp could be acquired. 836 836 */
-1
drivers/gpu/drm/i915/gem/i915_gem_object.h
··· 89 89 * @handle: userspace handle 90 90 * 91 91 * Returns: 92 - * 93 92 * A pointer to the object named by the handle if such exists on @filp, NULL 94 93 * otherwise. This object is only valid whilst under the RCU read lock, and 95 94 * note carefully the object may be in the process of being destroyed.
-1
drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c
··· 418 418 * For an untiled surface, this removes any existing fence. 419 419 * 420 420 * Returns: 421 - * 422 421 * 0 on success, negative error code on failure. 423 422 */ 424 423 int i915_vma_pin_fence(struct i915_vma *vma)
-1
drivers/gpu/drm/i915/i915_vma.h
··· 389 389 * i915_vma_unpin_fence(). 390 390 * 391 391 * Returns: 392 - * 393 392 * True if the vma has a fence, false otherwise. 394 393 */ 395 394 int __must_check i915_vma_pin_fence(struct i915_vma *vma);