linux-kernel - [RFC PATCH] drm/xe/doc: Mention Buffer Objects in doc without abbreviation

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>] [day] [month] [year] [list]

Message-ID: <20250908082609.1683192-1-dominik.marcel.weber@huawei.com>
Date: Mon, 8 Sep 2025 08:26:09 +0000
From: "Dominik M. Weber" <dominik.marcel.weber@...wei.com>
To: <corbet@....ne>
CC: <linux-doc@...r.kernel.org>, <linux-kernel@...r.kernel.org>, "Dominik M.
 Weber" <dominik.marcel.weber@...wei.com>
Subject: [RFC PATCH] drm/xe/doc: Mention Buffer Objects in doc without abbreviation

Add a new heading "Buffer Objects" in xe_mm documentation, grouping both
the related BO sections and explicitly stating what BO stands for.
This abbreviation is used all over the document, but is never written out.

Section markers are adapted to remain consistent relative to
included doc from drivers/gpu/drm/xe/xe_bo_doc.h.

Signed-off-by: Dominik M. Weber <dominik.marcel.weber@...wei.com>
---

I am aware of the guideline recommending sticking to the usual
heading adornments, though doing so is not possible here without
either necessitating larger changes in the kernel-doc comments
or breaking the current hierarchical formatting. Introducing +
hence seemed the cleaner solution.

Since this is not about the content change yet, this RFC is
sent only to documentation specific mailing lists.

---
 Documentation/gpu/xe/xe_mm.rst | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/Documentation/gpu/xe/xe_mm.rst b/Documentation/gpu/xe/xe_mm.rst
index 95864a4502dd..24a532979f1a 100644
--- a/Documentation/gpu/xe/xe_mm.rst
+++ b/Documentation/gpu/xe/xe_mm.rst
@@ -4,17 +4,20 @@
 Memory Management
 =================

+Buffer Objects
+++++++++++++++
+
 .. kernel-doc:: drivers/gpu/drm/xe/xe_bo_doc.h
    :doc: Buffer Objects (BO)

 GGTT
-====
+++++

 .. kernel-doc:: drivers/gpu/drm/xe/xe_ggtt.c
    :doc: Global Graphics Translation Table (GGTT)

 GGTT Internal API
------------------
+=================

 .. kernel-doc:: drivers/gpu/drm/xe/xe_ggtt_types.h
    :internal:
@@ -23,7 +26,7 @@ GGTT Internal API
    :internal:

 Pagetable building
-==================
+++++++++++++++++++

 .. kernel-doc:: drivers/gpu/drm/xe/xe_pt.c
    :doc: Pagetable building
-- 
2.43.0