Commit 3ca8b266 authored by Bagas Sanjaya's avatar Bagas Sanjaya Committed by Tvrtko Ursulin
Browse files

drm/ttm: Fix @alloc_flags description 



Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:

Documentation/gpu/drm-mm:40: include/drm/ttm/ttm_device.h:225: ERROR: Unknown target name: "ttm_allocation". [docutils]
Documentation/gpu/drm-mm:43: drivers/gpu/drm/ttm/ttm_device.c:202: ERROR: Unknown target name: "ttm_allocation". [docutils]
Documentation/gpu/drm-mm:73: include/drm/ttm/ttm_pool.h:68: ERROR: Unknown target name: "ttm_allocation_pool". [docutils]
Documentation/gpu/drm-mm:76: drivers/gpu/drm/ttm/ttm_pool.c:1070: ERROR: Unknown target name: "ttm_allocation_pool". [docutils]

Fix these by adding missing wildcard on TTM_ALLOCATION_* and
TTM_ALLOCATION_POOL_* in @alloc_flags description.

Fixes: 0af5b6a8 ("drm/ttm: Replace multiple booleans with flags in pool init")
Fixes: 77e19f8d ("drm/ttm: Replace multiple booleans with flags in device init")
Fixes: 402b3a86 ("drm/ttm: Add an allocation flag to propagate -ENOSPC on OOM")
Reported-by: default avatarStephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251105161838.55b962a3@canb.auug.org.au/


Signed-off-by: default avatarBagas Sanjaya <bagasdotme@gmail.com>
Acked-by: default avatarTvrtko Ursulin <tvrtko.ursulin@igalia.com>
Reviewed-by: default avatarChristian König <christian.koenig@amd.com>
Signed-off-by: default avatarTvrtko Ursulin <tursulin@ursulin.net>
Link: https://lore.kernel.org/r/20251106005217.14026-1-bagasdotme@gmail.com
parent b6fa6100

drivers/gpu/drm/ttm/ttm_device.c

+1 −1
Original line number Diff line number Diff line
@@ -199,7 +199,7 @@ EXPORT_SYMBOL(ttm_device_swapout); 
 * @dev: The core kernel device pointer for DMA mappings and allocations.

 * @mapping: The address space to use for this bo.

 * @vma_manager: A pointer to a vma manager.

 * @alloc_flags: TTM_ALLOCATION_ flags.

 * @alloc_flags: TTM_ALLOCATION_* flags.

 *

 * Initializes a struct ttm_device:

 * Returns:

drivers/gpu/drm/ttm/ttm_pool.c

+1 −1
Original line number Diff line number Diff line
@@ -1067,7 +1067,7 @@ long ttm_pool_backup(struct ttm_pool *pool, struct ttm_tt *tt, 
 * @pool: the pool to initialize

 * @dev: device for DMA allocations and mappings

 * @nid: NUMA node to use for allocations

 * @alloc_flags: TTM_ALLOCATION_POOL_ flags

 * @alloc_flags: TTM_ALLOCATION_POOL_* flags

 *

 * Initialize the pool and its pool types.

 */

include/drm/ttm/ttm_device.h

+1 −1
Original line number Diff line number Diff line
@@ -221,7 +221,7 @@ struct ttm_device { 
	struct list_head device_list;



	/**

	 * @alloc_flags: TTM_ALLOCATION_ flags.

	 * @alloc_flags: TTM_ALLOCATION_* flags.

	 */

	unsigned int alloc_flags;

include/drm/ttm/ttm_pool.h

+1 −1
Original line number Diff line number Diff line
@@ -64,7 +64,7 @@ struct ttm_pool_type { 
 *

 * @dev: the device we allocate pages for

 * @nid: which numa node to use

 * @alloc_flags: TTM_ALLOCATION_POOL_ flags

 * @alloc_flags: TTM_ALLOCATION_POOL_* flags

 * @caching: pools for each caching/order

 */

struct ttm_pool {