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

drm/vram-helper: Fix 'multi-line' kernel-doc comments

Reformat lines in kernel-doc comments, which make use of the backslash at
the end to suggest it is a multi-line comment. kernel-doc is able to
process e.g. the short description of a function properly, even if it is
across two lines.

No functional change.

Signed-off-by: Anna-Maria Behnsen <anna-maria@linutronix.de>
Reviewed-by: Jani Nikula <jani.nikula@intel.com>
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240122093152.22536-2-anna-maria@linutronix.de

authored by

Anna-Maria Behnsen and committed by
Jonathan Corbet
a0abb82d d546978e

+28 -32
+20 -24
drivers/gpu/drm/drm_gem_vram_helper.c
··· 260 260 } 261 261 262 262 /** 263 - * drm_gem_vram_offset() - \ 264 - Returns a GEM VRAM object's offset in video memory 263 + * drm_gem_vram_offset() - Returns a GEM VRAM object's offset in video memory 265 264 * @gbo: the GEM VRAM object 266 265 * 267 266 * This function returns the buffer object's offset in the device's video ··· 469 470 EXPORT_SYMBOL(drm_gem_vram_vunmap); 470 471 471 472 /** 472 - * drm_gem_vram_fill_create_dumb() - \ 473 - Helper for implementing &struct drm_driver.dumb_create 473 + * drm_gem_vram_fill_create_dumb() - Helper for implementing 474 + * &struct drm_driver.dumb_create 475 + * 474 476 * @file: the DRM file 475 477 * @dev: the DRM device 476 478 * @pg_align: the buffer's alignment in multiples of the page size 477 479 * @pitch_align: the scanline's alignment in powers of 2 478 - * @args: the arguments as provided to \ 479 - &struct drm_driver.dumb_create 480 + * @args: the arguments as provided to 481 + * &struct drm_driver.dumb_create 480 482 * 481 483 * This helper function fills &struct drm_mode_create_dumb, which is used 482 484 * by &struct drm_driver.dumb_create. Implementations of this interface ··· 575 575 */ 576 576 577 577 /** 578 - * drm_gem_vram_object_free() - \ 579 - Implements &struct drm_gem_object_funcs.free 578 + * drm_gem_vram_object_free() - Implements &struct drm_gem_object_funcs.free 580 579 * @gem: GEM object. Refers to &struct drm_gem_vram_object.gem 581 580 */ 582 581 static void drm_gem_vram_object_free(struct drm_gem_object *gem) ··· 590 591 */ 591 592 592 593 /** 593 - * drm_gem_vram_driver_dumb_create() - \ 594 - Implements &struct drm_driver.dumb_create 594 + * drm_gem_vram_driver_dumb_create() - Implements &struct drm_driver.dumb_create 595 595 * @file: the DRM file 596 596 * @dev: the DRM device 597 - * @args: the arguments as provided to \ 598 - &struct drm_driver.dumb_create 597 + * @args: the arguments as provided to 598 + * &struct drm_driver.dumb_create 599 599 * 600 600 * This function requires the driver to use @drm_device.vram_mm for its 601 601 * instance of VRAM MM. ··· 637 639 } 638 640 639 641 /** 640 - * drm_gem_vram_plane_helper_prepare_fb() - \ 641 - * Implements &struct drm_plane_helper_funcs.prepare_fb 642 + * drm_gem_vram_plane_helper_prepare_fb() - Implements &struct 643 + * drm_plane_helper_funcs.prepare_fb 642 644 * @plane: a DRM plane 643 645 * @new_state: the plane's new state 644 646 * ··· 688 690 EXPORT_SYMBOL(drm_gem_vram_plane_helper_prepare_fb); 689 691 690 692 /** 691 - * drm_gem_vram_plane_helper_cleanup_fb() - \ 692 - * Implements &struct drm_plane_helper_funcs.cleanup_fb 693 + * drm_gem_vram_plane_helper_cleanup_fb() - Implements &struct 694 + * drm_plane_helper_funcs.cleanup_fb 693 695 * @plane: a DRM plane 694 696 * @old_state: the plane's old state 695 697 * ··· 715 717 */ 716 718 717 719 /** 718 - * drm_gem_vram_simple_display_pipe_prepare_fb() - \ 719 - * Implements &struct drm_simple_display_pipe_funcs.prepare_fb 720 + * drm_gem_vram_simple_display_pipe_prepare_fb() - Implements &struct 721 + * drm_simple_display_pipe_funcs.prepare_fb 720 722 * @pipe: a simple display pipe 721 723 * @new_state: the plane's new state 722 724 * ··· 737 739 EXPORT_SYMBOL(drm_gem_vram_simple_display_pipe_prepare_fb); 738 740 739 741 /** 740 - * drm_gem_vram_simple_display_pipe_cleanup_fb() - \ 741 - * Implements &struct drm_simple_display_pipe_funcs.cleanup_fb 742 + * drm_gem_vram_simple_display_pipe_cleanup_fb() - Implements &struct 743 + * drm_simple_display_pipe_funcs.cleanup_fb 742 744 * @pipe: a simple display pipe 743 745 * @old_state: the plane's old state 744 746 * ··· 759 761 */ 760 762 761 763 /** 762 - * drm_gem_vram_object_pin() - \ 763 - Implements &struct drm_gem_object_funcs.pin 764 + * drm_gem_vram_object_pin() - Implements &struct drm_gem_object_funcs.pin 764 765 * @gem: The GEM object to pin 765 766 * 766 767 * Returns: ··· 782 785 } 783 786 784 787 /** 785 - * drm_gem_vram_object_unpin() - \ 786 - Implements &struct drm_gem_object_funcs.unpin 788 + * drm_gem_vram_object_unpin() - Implements &struct drm_gem_object_funcs.unpin 787 789 * @gem: The GEM object to unpin 788 790 */ 789 791 static void drm_gem_vram_object_unpin(struct drm_gem_object *gem)
+8 -8
include/drm/drm_gem_vram_helper.h
··· 33 33 * struct drm_gem_vram_object - GEM object backed by VRAM 34 34 * @bo: TTM buffer object 35 35 * @map: Mapping information for @bo 36 - * @placement: TTM placement information. Supported placements are \ 37 - %TTM_PL_VRAM and %TTM_PL_SYSTEM 36 + * @placement: TTM placement information. Supported placements are %TTM_PL_VRAM 37 + * and %TTM_PL_SYSTEM 38 38 * @placements: TTM placement information. 39 39 * 40 40 * The type struct drm_gem_vram_object represents a GEM object that is ··· 126 126 struct drm_plane_state *old_state); 127 127 128 128 /** 129 - * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - 130 - * Initializes struct drm_plane_helper_funcs for VRAM handling 129 + * DRM_GEM_VRAM_PLANE_HELPER_FUNCS - Initializes struct drm_plane_helper_funcs 130 + * for VRAM handling 131 131 * 132 132 * Drivers may use GEM BOs as VRAM helpers for the framebuffer memory. This 133 133 * macro initializes struct drm_plane_helper_funcs to use the respective helper ··· 150 150 struct drm_plane_state *old_state); 151 151 152 152 /** 153 - * define DRM_GEM_VRAM_DRIVER - default callback functions for \ 154 - &struct drm_driver 153 + * define DRM_GEM_VRAM_DRIVER - default callback functions for 154 + * &struct drm_driver 155 155 * 156 156 * Drivers that use VRAM MM and GEM VRAM can use this macro to initialize 157 157 * &struct drm_driver with default functions. ··· 185 185 }; 186 186 187 187 /** 188 - * drm_vram_mm_of_bdev() - \ 189 - Returns the container of type &struct ttm_device for field bdev. 188 + * drm_vram_mm_of_bdev() - Returns the container of type &struct ttm_device for 189 + * field bdev. 190 190 * @bdev: the TTM BO device 191 191 * 192 192 * Returns: