linux-kernel - Re: [PATCH 2/2] accel/qaic: Format DBC states table in sysfs ABI documentation

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Message-ID: <0c6eb45b-0e9a-4bb0-9ee0-71752cbbe9c5@infradead.org>
Date: Sun, 9 Nov 2025 21:52:45 -0800
From: Randy Dunlap <rdunlap@...radead.org>
To: Bagas Sanjaya <bagasdotme@...il.com>,
 Linux Kernel Mailing List <linux-kernel@...r.kernel.org>,
 Linux Documentation <linux-doc@...r.kernel.org>,
 Linux ARM MSM <linux-arm-msm@...r.kernel.org>,
 Linux DRI Development <dri-devel@...ts.freedesktop.org>
Cc: Jeff Hugo <jeff.hugo@....qualcomm.com>,
 Carl Vanderlip <carl.vanderlip@....qualcomm.com>,
 Oded Gabbay <ogabbay@...nel.org>, Jonathan Corbet <corbet@....net>,
 Youssef Samir <youssef.abdulrahman@....qualcomm.com>,
 Pranjal Ramajor Asha Kanojiya <quic_pkanojiy@...cinc.com>,
 Zack McKevitt <zachary.mckevitt@....qualcomm.com>,
 Aswin Venkatesan <aswivenk@....qualcomm.com>,
 Stephen Rothwell <sfr@...b.auug.org.au>
Subject: Re: [PATCH 2/2] accel/qaic: Format DBC states table in sysfs ABI
 documentation



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@...b.auug.org.au>
> Closes: https://lore.kernel.org/linux-next/20251110135038.29e96051@canb.auug.org.au/
> Signed-off-by: Bagas Sanjaya <bagasdotme@...il.com>

Reviewed-by: Randy Dunlap <rdunlap@...radead.org>
Tested-by: Randy Dunlap <rdunlap@...radead.org>

> ---
>  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@....qualcomm.com>
>  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