[PATCH RESEND v2] Documentation: xe_drm: fix chars used for subsection

[PATCH RESEND v2] Documentation: xe_drm: fix chars used for subsection

[Rafael Passos]

Fixes "ERROR: A level 2 section cannot be used here".
Equal signs are reserved for document titles.
This file docs gets imported by driver-uapi.rst,
and the page title is defined there.


Signed-off-by: Rafael Passos <rafael@rcpassos.me>
---
Hi, I send the v1 for this patch only for the linux-doc list.
The v2 fixes this, and has improvements to the commit message.

It was reviewed and tested by Randy Dunlap.
I decided to re-send since the original emails was not in picked by lore (not sure why).
https://lore.kernel.org/intel-xe/1a20e4bf-fd7f-453e-b7a8-c7feb0b077c6@infradead.org/

In case it helps, here are the tags Randy added in my first send:
Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks,
Rafael Passos

 include/uapi/drm/xe_drm.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
index 48e9f1fdb78d..4dfb30e6c8a8 100644
--- a/include/uapi/drm/xe_drm.h
+++ b/include/uapi/drm/xe_drm.h
@@ -2537,21 +2537,21 @@ struct drm_xe_exec_queue_set_property {
  * Refer to Documentation/netlink/specs/drm_ras.yaml for complete interface specification.
  *
  * Node Registration
- * =================
+ * -----------------
  *
  * The driver registers DRM RAS nodes for each error severity level.
  * enum drm_xe_ras_error_severity defines the node-id, while DRM_XE_RAS_ERROR_SEVERITY_NAMES maps
  * node-id to node-name.
  *
  * Error Classification
- * ====================
+ * --------------------
  *
  * Each node contains a list of error counters. Each error is identified by a error-id and
  * an error-name. enum drm_xe_ras_error_component defines the error-id, while
  * DRM_XE_RAS_ERROR_COMPONENT_NAMES maps error-id to error-name.
  *
  * User Interface
- * ==============
+ * --------------
  *
  * To retrieve error values of a error counter, userspace applications should
  * follow the below steps:
-- 
2.53.0

Re: [PATCH RESEND v2] Documentation: xe_drm: fix chars used for subsection

[Rodrigo Vivi]

On Tue, Jun 30, 2026 at 10:20:58PM -0300, Rafael Passos wrote:
> Fixes "ERROR: A level 2 section cannot be used here".
> Equal signs are reserved for document titles.
> This file docs gets imported by driver-uapi.rst,
> and the page title is defined there.
> 
> 
> Signed-off-by: Rafael Passos <rafael@rcpassos.me>
> ---
> Hi, I send the v1 for this patch only for the linux-doc list.
> The v2 fixes this, and has improvements to the commit message.
> 
> It was reviewed and tested by Randy Dunlap.
> I decided to re-send since the original emails was not in picked by lore (not sure why).
> https://lore.kernel.org/intel-xe/1a20e4bf-fd7f-453e-b7a8-c7feb0b077c6@infradead.org/
> 
> In case it helps, here are the tags Randy added in my first send:
> Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
> Tested-by: Randy Dunlap <rdunlap@infradead.org>

Next time, please put these directly above the '---' along with your sign-off.
And please use the standard 'drm/xe:' tag in the subject.

I modified the subject and pushed it to drm-xe-next. Thanks for the patch.

> 
> Thanks,
> Rafael Passos
> 
>  include/uapi/drm/xe_drm.h | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/include/uapi/drm/xe_drm.h b/include/uapi/drm/xe_drm.h
> index 48e9f1fdb78d..4dfb30e6c8a8 100644
> --- a/include/uapi/drm/xe_drm.h
> +++ b/include/uapi/drm/xe_drm.h
> @@ -2537,21 +2537,21 @@ struct drm_xe_exec_queue_set_property {
>   * Refer to Documentation/netlink/specs/drm_ras.yaml for complete interface specification.
>   *
>   * Node Registration
> - * =================
> + * -----------------
>   *
>   * The driver registers DRM RAS nodes for each error severity level.
>   * enum drm_xe_ras_error_severity defines the node-id, while DRM_XE_RAS_ERROR_SEVERITY_NAMES maps
>   * node-id to node-name.
>   *
>   * Error Classification
> - * ====================
> + * --------------------
>   *
>   * Each node contains a list of error counters. Each error is identified by a error-id and
>   * an error-name. enum drm_xe_ras_error_component defines the error-id, while
>   * DRM_XE_RAS_ERROR_COMPONENT_NAMES maps error-id to error-name.
>   *
>   * User Interface
> - * ==============
> + * --------------
>   *
>   * To retrieve error values of a error counter, userspace applications should
>   * follow the below steps:
> -- 
> 2.53.0
>