Skip to content

Commit 22bc22c

Browse files
renjun wangtdz
authored andcommitted
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
1 parent cf4d37b commit 22bc22c

11 files changed

Lines changed: 2 additions & 31 deletions

File tree

drivers/gpu/drm/display/drm_dp_mst_topology.c

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5569,7 +5569,6 @@ EXPORT_SYMBOL(drm_dp_mst_atomic_check_mgr);
55695569
* drm_dp_atomic_release_time_slots()
55705570
*
55715571
* Returns:
5572-
*
55735572
* 0 if the new state is valid, negative error code otherwise.
55745573
*/
55755574
int drm_dp_mst_atomic_check(struct drm_atomic_state *state)
@@ -5606,7 +5605,6 @@ EXPORT_SYMBOL(drm_dp_mst_topology_state_funcs);
56065605
* topology object.
56075606
*
56085607
* RETURNS:
5609-
*
56105608
* The MST topology state or error pointer.
56115609
*/
56125610
struct drm_dp_mst_topology_state *drm_atomic_get_mst_topology_state(struct drm_atomic_state *state,
@@ -5626,7 +5624,6 @@ EXPORT_SYMBOL(drm_atomic_get_mst_topology_state);
56265624
* topology object.
56275625
*
56285626
* Returns:
5629-
*
56305627
* The old MST topology state, or NULL if there's no topology state for this MST mgr
56315628
* in the global atomic state
56325629
*/
@@ -5651,7 +5648,6 @@ EXPORT_SYMBOL(drm_atomic_get_old_mst_topology_state);
56515648
* topology object.
56525649
*
56535650
* Returns:
5654-
*
56555651
* The new MST topology state, or NULL if there's no topology state for this MST mgr
56565652
* in the global atomic state
56575653
*/

drivers/gpu/drm/drm_atomic.c

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,6 @@ EXPORT_SYMBOL(__drm_crtc_commit_free);
6363
* hardware and flipped to.
6464
*
6565
* Returns:
66-
*
6766
* 0 on success, a negative error code otherwise.
6867
*/
6968
int drm_crtc_commit_wait(struct drm_crtc_commit *commit)
@@ -337,7 +336,6 @@ EXPORT_SYMBOL(__drm_atomic_state_free);
337336
* not created by userspace through an IOCTL call.
338337
*
339338
* Returns:
340-
*
341339
* Either the allocated state or the error code encoded into the pointer. When
342340
* the error is EDEADLK then the w/w mutex code has detected a deadlock and the
343341
* entire atomic sequence must be restarted. All other errors are fatal.
@@ -518,7 +516,6 @@ static int drm_atomic_connector_check(struct drm_connector *connector,
518516
* is consistent.
519517
*
520518
* Returns:
521-
*
522519
* Either the allocated state or the error code encoded into the pointer. When
523520
* the error is EDEADLK then the w/w mutex code has detected a deadlock and the
524521
* entire atomic sequence must be restarted. All other errors are fatal.
@@ -828,7 +825,6 @@ EXPORT_SYMBOL(drm_atomic_private_obj_fini);
828825
* object lock to make sure that the state is consistent.
829826
*
830827
* RETURNS:
831-
*
832828
* Either the allocated state or the error code encoded into a pointer.
833829
*/
834830
struct drm_private_state *
@@ -1061,7 +1057,6 @@ EXPORT_SYMBOL(drm_atomic_get_new_crtc_for_encoder);
10611057
* make sure that the state is consistent.
10621058
*
10631059
* Returns:
1064-
*
10651060
* Either the allocated state or the error code encoded into the pointer. When
10661061
* the error is EDEADLK then the w/w mutex code has detected a deadlock and the
10671062
* entire atomic sequence must be restarted. All other errors are fatal.
@@ -1169,7 +1164,6 @@ static void drm_atomic_connector_print_state(struct drm_printer *p,
11691164
* state is consistent.
11701165
*
11711166
* Returns:
1172-
*
11731167
* Either the allocated state or the error code encoded into the pointer. When
11741168
* the error is EDEADLK then the w/w mutex code has detected a deadlock and the
11751169
* entire atomic sequence must be restarted.

drivers/gpu/drm/drm_atomic_helper.c

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2266,7 +2266,6 @@ crtc_or_fake_commit(struct drm_atomic_state *state, struct drm_crtc *crtc)
22662266
* automatically.
22672267
*
22682268
* Returns:
2269-
*
22702269
* 0 on success. -EBUSY when userspace schedules nonblocking commits too fast,
22712270
* -ENOMEM on allocation failures and -EINTR when a signal is pending.
22722271
*/
@@ -3009,7 +3008,6 @@ EXPORT_SYMBOL(drm_atomic_helper_cleanup_planes);
30093008
* don't pass the right state structures to the callbacks.
30103009
*
30113010
* Returns:
3012-
*
30133011
* Returns 0 on success. Can return -ERESTARTSYS when @stall is true and the
30143012
* waiting for the previous commits has been interrupted.
30153013
*/

drivers/gpu/drm/drm_file.c

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -347,7 +347,6 @@ int drm_open_helper(struct file *filp, struct drm_minor *minor)
347347
* resources for it. It also calls the &drm_driver.open driver callback.
348348
*
349349
* RETURNS:
350-
*
351350
* 0 on success or negative errno value on failure.
352351
*/
353352
int drm_open(struct inode *inode, struct file *filp)
@@ -406,7 +405,6 @@ static void drm_lastclose(struct drm_device *dev)
406405
* in-kernel DRM client.
407406
*
408407
* RETURNS:
409-
*
410408
* Always succeeds and returns 0.
411409
*/
412410
int drm_release(struct inode *inode, struct file *filp)
@@ -477,7 +475,6 @@ void drm_file_update_pid(struct drm_file *filp)
477475
* then restores the active in-kernel DRM client.
478476
*
479477
* RETURNS:
480-
*
481478
* Always succeeds and returns 0.
482479
*/
483480
int drm_release_noglobal(struct inode *inode, struct file *filp)
@@ -520,7 +517,6 @@ EXPORT_SYMBOL(drm_release_noglobal);
520517
* safety.
521518
*
522519
* RETURNS:
523-
*
524520
* Number of bytes read (always aligned to full events, and can be 0) or a
525521
* negative error code on failure.
526522
*/
@@ -606,7 +602,6 @@ EXPORT_SYMBOL(drm_read);
606602
* See also drm_read().
607603
*
608604
* RETURNS:
609-
*
610605
* Mask of POLL flags indicating the current status of the file.
611606
*/
612607
__poll_t drm_poll(struct file *filp, struct poll_table_struct *wait)
@@ -644,7 +639,6 @@ EXPORT_SYMBOL(drm_poll);
644639
* already hold &drm_device.event_lock.
645640
*
646641
* RETURNS:
647-
*
648642
* 0 on success or a negative error code on failure.
649643
*/
650644
int drm_event_reserve_init_locked(struct drm_device *dev,
@@ -686,7 +680,6 @@ EXPORT_SYMBOL(drm_event_reserve_init_locked);
686680
* drm_event_reserve_init_locked() instead.
687681
*
688682
* RETURNS:
689-
*
690683
* 0 on success or a negative error code on failure.
691684
*/
692685
int drm_event_reserve_init(struct drm_device *dev,

drivers/gpu/drm/drm_gem.c

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -689,7 +689,6 @@ static int objects_lookup(struct drm_file *filp, u32 *handle, int count,
689689
* For a single handle lookup, use drm_gem_object_lookup().
690690
*
691691
* Returns:
692-
*
693692
* @objs filled in with GEM object pointers. Returned GEM objects need to be
694693
* released with drm_gem_object_put(). -ENOENT is returned on a lookup
695694
* failure. 0 is returned on success.
@@ -737,12 +736,11 @@ EXPORT_SYMBOL(drm_gem_objects_lookup);
737736
* @filp: DRM file private date
738737
* @handle: userspace handle
739738
*
740-
* Returns:
739+
* If looking up an array of handles, use drm_gem_objects_lookup().
741740
*
741+
* Returns:
742742
* A reference to the object named by the handle if such exists on @filp, NULL
743743
* otherwise.
744-
*
745-
* If looking up an array of handles, use drm_gem_objects_lookup().
746744
*/
747745
struct drm_gem_object *
748746
drm_gem_object_lookup(struct drm_file *filp, u32 handle)
@@ -763,7 +761,6 @@ EXPORT_SYMBOL(drm_gem_object_lookup);
763761
* @timeout: timeout value in jiffies or zero to return immediately
764762
*
765763
* Returns:
766-
*
767764
* Returns -ERESTARTSYS if interrupted, 0 if the wait timed out, or
768765
* greater than 0 on success.
769766
*/

drivers/gpu/drm/drm_modes.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -539,7 +539,6 @@ static int fill_analog_mode(struct drm_device *dev,
539539
* to reach those resolutions.
540540
*
541541
* Returns:
542-
*
543542
* A pointer to the mode, allocated with drm_mode_create(). Returns NULL
544543
* on error.
545544
*/

drivers/gpu/drm/drm_rect.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,6 @@ static u32 clip_scaled(int src, int dst, int *clip)
8585
* factors from @src to @dst.
8686
*
8787
* RETURNS:
88-
*
8988
* %true if rectangle @dst is still visible after being clipped,
9089
* %false otherwise.
9190
*/

drivers/gpu/drm/drm_vblank.c

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -686,7 +686,6 @@ EXPORT_SYMBOL(drm_calc_timestamping_constants);
686686
* drm_atomic_helper_calc_timestamping_constants().
687687
*
688688
* Returns:
689-
*
690689
* Returns true on success, and false on failure, i.e. when no accurate
691690
* timestamp could be acquired.
692691
*/
@@ -831,7 +830,6 @@ EXPORT_SYMBOL(drm_crtc_vblank_helper_get_vblank_timestamp_internal);
831830
* drm_atomic_helper_calc_timestamping_constants().
832831
*
833832
* Returns:
834-
*
835833
* Returns true on success, and false on failure, i.e. when no accurate
836834
* timestamp could be acquired.
837835
*/

drivers/gpu/drm/i915/gem/i915_gem_object.h

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,6 @@ __i915_gem_object_unset_pages(struct drm_i915_gem_object *obj);
8989
* @handle: userspace handle
9090
*
9191
* Returns:
92-
*
9392
* A pointer to the object named by the handle if such exists on @filp, NULL
9493
* otherwise. This object is only valid whilst under the RCU read lock, and
9594
* note carefully the object may be in the process of being destroyed.

drivers/gpu/drm/i915/gt/intel_ggtt_fencing.c

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,7 +418,6 @@ int __i915_vma_pin_fence(struct i915_vma *vma)
418418
* For an untiled surface, this removes any existing fence.
419419
*
420420
* Returns:
421-
*
422421
* 0 on success, negative error code on failure.
423422
*/
424423
int i915_vma_pin_fence(struct i915_vma *vma)

0 commit comments

Comments
 (0)