Re: [PATCH 2/2] accel/qaic: Format DBC states table in sysfs ABI documentation
From: Randy Dunlap
Date: Mon Nov 10 2025 - 00:53:08 EST
On 11/9/25 7:59 PM, Bagas Sanjaya wrote:
> Stephen Rothwell reports htmldocs warnings when merging drm-misc tree:
>
> Documentation/ABI/stable/sysfs-driver-qaic:1: ERROR: Unexpected indentation. [docutils]
> Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Block quote ends without a blank line; unexpected unindent. [docutils]
> Documentation/ABI/stable/sysfs-driver-qaic:1: WARNING: Definition list ends without a blank line; unexpected unindent. [docutils]
>
> These are caused by DMA Bridge channel (DBC) states list in sysfs ABI
> docs. Format it as a table to fix them.
>
> Fixes: f286066ed9df38 ("accel/qaic: Add DMA Bridge Channel(DBC) sysfs and uevents")
> Reported-by: Stephen Rothwell <sfr@xxxxxxxxxxxxxxxx>
> Closes: https://lore.kernel.org/linux-next/20251110135038.29e96051@xxxxxxxxxxxxxxxx/
> Signed-off-by: Bagas Sanjaya <bagasdotme@xxxxxxxxx>
Reviewed-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
Tested-by: Randy Dunlap <rdunlap@xxxxxxxxxxxxx>
> ---
> Documentation/ABI/stable/sysfs-driver-qaic | 17 ++++++++++-------
> 1 file changed, 10 insertions(+), 7 deletions(-)
>
> diff --git a/Documentation/ABI/stable/sysfs-driver-qaic b/Documentation/ABI/stable/sysfs-driver-qaic
> index e5876935e62b34..c767a93342b3c9 100644
> --- a/Documentation/ABI/stable/sysfs-driver-qaic
> +++ b/Documentation/ABI/stable/sysfs-driver-qaic
> @@ -3,14 +3,17 @@ Date: October 2025
> KernelVersion: 6.19
> Contact: Jeff Hugo <jeff.hugo@xxxxxxxxxxxxxxxx>
> Description: Represents the current state of DMA Bridge channel (DBC). Below are the possible
> - states,
> - IDLE (0) - DBC is free and can be activated
> - ASSIGNED (1) - DBC is activated and a workload is running on device
> - BEFORE_SHUTDOWN (2) - Sub-system associated with this workload has crashed and
> + states:
> +
> + =================== ==========================================================
> + IDLE (0) DBC is free and can be activated
> + ASSIGNED (1) DBC is activated and a workload is running on device
> + BEFORE_SHUTDOWN (2) Sub-system associated with this workload has crashed and
> it will shutdown soon
> - AFTER_SHUTDOWN (3) - Sub-system associated with this workload has crashed and
> + AFTER_SHUTDOWN (3) Sub-system associated with this workload has crashed and
> it has shutdown
> - BEFORE_POWER_UP (4) - Sub-system associated with this workload is shutdown and
> + BEFORE_POWER_UP (4) Sub-system associated with this workload is shutdown and
> it will be powered up soon
> - AFTER_POWER_UP (5) - Sub-system associated with this workload is now powered up
> + AFTER_POWER_UP (5) Sub-system associated with this workload is now powered up
> + =================== ==========================================================
> Users: Any userspace application or clients interested in DBC state.
--
~Randy