drm/ttm: Fix @alloc_flags description

[PATCH] drm/ttm: Fix @alloc_flags description

Posted by Bagas Sanjaya 1 month, 1 week ago

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: 0af5b6a8f8dd ("drm/ttm: Replace multiple booleans with flags in pool init")
Fixes: 77e19f8d3297 ("drm/ttm: Replace multiple booleans with flags in device init")
Fixes: 402b3a865090 ("drm/ttm: Add an allocation flag to propagate -ENOSPC on OOM")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Closes: https://lore.kernel.org/linux-next/20251105161838.55b962a3@canb.auug.org.au/
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
 drivers/gpu/drm/ttm/ttm_device.c | 2 +-
 drivers/gpu/drm/ttm/ttm_pool.c   | 2 +-
 include/drm/ttm/ttm_device.h     | 2 +-
 include/drm/ttm/ttm_pool.h       | 2 +-
 4 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/drivers/gpu/drm/ttm/ttm_device.c b/drivers/gpu/drm/ttm/ttm_device.c
index 5c10e5fbf43b7f..9a51afaf0749e2 100644
--- a/drivers/gpu/drm/ttm/ttm_device.c
+++ b/drivers/gpu/drm/ttm/ttm_device.c
@@ -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:
diff --git a/drivers/gpu/drm/ttm/ttm_pool.c b/drivers/gpu/drm/ttm/ttm_pool.c
index 97e9ce505cf68d..18b6db015619c0 100644
--- a/drivers/gpu/drm/ttm/ttm_pool.c
+++ b/drivers/gpu/drm/ttm/ttm_pool.c
@@ -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.
  */
diff --git a/include/drm/ttm/ttm_device.h b/include/drm/ttm/ttm_device.h
index d016360e5cebbc..5618aef462f21b 100644
--- a/include/drm/ttm/ttm_device.h
+++ b/include/drm/ttm/ttm_device.h
@@ -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;
 
diff --git a/include/drm/ttm/ttm_pool.h b/include/drm/ttm/ttm_pool.h
index 67c72de913bb9d..233581670e7825 100644
--- a/include/drm/ttm/ttm_pool.h
+++ b/include/drm/ttm/ttm_pool.h
@@ -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 {

base-commit: c553832116b8d0039b13ae84d1ed06e7ee4f1fdf
-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] drm/ttm: Fix @alloc_flags description

Posted by Christian König 1 month, 1 week ago

On 11/6/25 01:52, Bagas Sanjaya wrote:
> 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: 0af5b6a8f8dd ("drm/ttm: Replace multiple booleans with flags in pool init")
> Fixes: 77e19f8d3297 ("drm/ttm: Replace multiple booleans with flags in device init")
> Fixes: 402b3a865090 ("drm/ttm: Add an allocation flag to propagate -ENOSPC on OOM")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251105161838.55b962a3@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>

Reviewed-by: Christian König <christian.koenig@amd.com>

> ---
>  drivers/gpu/drm/ttm/ttm_device.c | 2 +-
>  drivers/gpu/drm/ttm/ttm_pool.c   | 2 +-
>  include/drm/ttm/ttm_device.h     | 2 +-
>  include/drm/ttm/ttm_pool.h       | 2 +-
>  4 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/gpu/drm/ttm/ttm_device.c b/drivers/gpu/drm/ttm/ttm_device.c
> index 5c10e5fbf43b7f..9a51afaf0749e2 100644
> --- a/drivers/gpu/drm/ttm/ttm_device.c
> +++ b/drivers/gpu/drm/ttm/ttm_device.c
> @@ -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:
> diff --git a/drivers/gpu/drm/ttm/ttm_pool.c b/drivers/gpu/drm/ttm/ttm_pool.c
> index 97e9ce505cf68d..18b6db015619c0 100644
> --- a/drivers/gpu/drm/ttm/ttm_pool.c
> +++ b/drivers/gpu/drm/ttm/ttm_pool.c
> @@ -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.
>   */
> diff --git a/include/drm/ttm/ttm_device.h b/include/drm/ttm/ttm_device.h
> index d016360e5cebbc..5618aef462f21b 100644
> --- a/include/drm/ttm/ttm_device.h
> +++ b/include/drm/ttm/ttm_device.h
> @@ -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;
>  
> diff --git a/include/drm/ttm/ttm_pool.h b/include/drm/ttm/ttm_pool.h
> index 67c72de913bb9d..233581670e7825 100644
> --- a/include/drm/ttm/ttm_pool.h
> +++ b/include/drm/ttm/ttm_pool.h
> @@ -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 {
> 
> base-commit: c553832116b8d0039b13ae84d1ed06e7ee4f1fdf

Re: [PATCH] drm/ttm: Fix @alloc_flags description

Posted by Tvrtko Ursulin 1 month, 1 week ago

On 06/11/2025 00:52, Bagas Sanjaya wrote:
> 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.

Interesting, I did not realize it would see special meaning in text 
followed by underscore. Thanks for fixing it up!

Acked-by: Tvrtko Ursulin <tvrtko.ursulin@igalia.com>

I assume no one merged it yet to any branch so I can push it to 
drm-misc-next?

Regards,

Tvrtko

> Fixes: 0af5b6a8f8dd ("drm/ttm: Replace multiple booleans with flags in pool init")
> Fixes: 77e19f8d3297 ("drm/ttm: Replace multiple booleans with flags in device init")
> Fixes: 402b3a865090 ("drm/ttm: Add an allocation flag to propagate -ENOSPC on OOM")
> Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251105161838.55b962a3@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
> ---
>   drivers/gpu/drm/ttm/ttm_device.c | 2 +-
>   drivers/gpu/drm/ttm/ttm_pool.c   | 2 +-
>   include/drm/ttm/ttm_device.h     | 2 +-
>   include/drm/ttm/ttm_pool.h       | 2 +-
>   4 files changed, 4 insertions(+), 4 deletions(-)
> 
> diff --git a/drivers/gpu/drm/ttm/ttm_device.c b/drivers/gpu/drm/ttm/ttm_device.c
> index 5c10e5fbf43b7f..9a51afaf0749e2 100644
> --- a/drivers/gpu/drm/ttm/ttm_device.c
> +++ b/drivers/gpu/drm/ttm/ttm_device.c
> @@ -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:
> diff --git a/drivers/gpu/drm/ttm/ttm_pool.c b/drivers/gpu/drm/ttm/ttm_pool.c
> index 97e9ce505cf68d..18b6db015619c0 100644
> --- a/drivers/gpu/drm/ttm/ttm_pool.c
> +++ b/drivers/gpu/drm/ttm/ttm_pool.c
> @@ -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.
>    */
> diff --git a/include/drm/ttm/ttm_device.h b/include/drm/ttm/ttm_device.h
> index d016360e5cebbc..5618aef462f21b 100644
> --- a/include/drm/ttm/ttm_device.h
> +++ b/include/drm/ttm/ttm_device.h
> @@ -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;
>   
> diff --git a/include/drm/ttm/ttm_pool.h b/include/drm/ttm/ttm_pool.h
> index 67c72de913bb9d..233581670e7825 100644
> --- a/include/drm/ttm/ttm_pool.h
> +++ b/include/drm/ttm/ttm_pool.h
> @@ -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 {
> 
> base-commit: c553832116b8d0039b13ae84d1ed06e7ee4f1fdf

Re: [PATCH] drm/ttm: Fix @alloc_flags description

Posted by Bagas Sanjaya 1 month, 1 week ago

On Thu, Nov 06, 2025 at 08:28:15AM +0000, Tvrtko Ursulin wrote:
> I assume no one merged it yet to any branch so I can push it to
> drm-misc-next?

Of course!

-- 
An old man doll... just what I always wanted! - Clara

Re: [PATCH] drm/ttm: Fix @alloc_flags description

Posted by Tvrtko Ursulin 1 month, 1 week ago

On 06/11/2025 10:33, Bagas Sanjaya wrote:
> On Thu, Nov 06, 2025 at 08:28:15AM +0000, Tvrtko Ursulin wrote:
>> I assume no one merged it yet to any branch so I can push it to
>> drm-misc-next?
> 
> Of course!

Pushed, thanks again for fixing it!

Regards,

Tvrtko