[PATCH 1/2] Documentation: coresight: Extend title heading syntax in TPDM and TPDA documentation

Bagas Sanjaya bagasdotme at gmail.com
Fri Jan 20 20:00:13 PST 2023


kernel test robot reported htmldocs warnings:

Documentation/trace/coresight/coresight-tpda.rst:3: WARNING: Title overline too short.
Documentation/trace/coresight/coresight-tpdm.rst:3: WARNING: Title overline too short.

Extend title heading syntax (overline and underline) to match title text to
fix these warnings.

While at it, trim unneeded period in the title text.

Link: https://lore.kernel.org/linux-doc/202301210955.zYxDrLgv-lkp@intel.com/
Fixes: 758d638667d474 ("Documentation: trace: Add documentation for TPDM and TPDA")
Reported-by: kernel test robot <lkp at intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme at gmail.com>
---
 Documentation/trace/coresight/coresight-tpda.rst | 6 +++---
 Documentation/trace/coresight/coresight-tpdm.rst | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/trace/coresight/coresight-tpda.rst b/Documentation/trace/coresight/coresight-tpda.rst
index 350dad4eda4721..a37f387ceaea13 100644
--- a/Documentation/trace/coresight/coresight-tpda.rst
+++ b/Documentation/trace/coresight/coresight-tpda.rst
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-==============================
-The trace performance monitoring and diagnostics aggregator(TPDA).
-==============================
+=================================================================
+The trace performance monitoring and diagnostics aggregator(TPDA)
+=================================================================
 
     :Author:   Jinlong Mao <quic_jinlmao at quicinc.com>
     :Date:     January 2023
diff --git a/Documentation/trace/coresight/coresight-tpdm.rst b/Documentation/trace/coresight/coresight-tpdm.rst
index 4ba40b0db550da..6c6e95109072fa 100644
--- a/Documentation/trace/coresight/coresight-tpdm.rst
+++ b/Documentation/trace/coresight/coresight-tpdm.rst
@@ -1,8 +1,8 @@
 .. SPDX-License-Identifier: GPL-2.0
 
-==============================
-Trace performance monitoring and diagnostics monitor(TPDM).
-==============================
+==========================================================
+Trace performance monitoring and diagnostics monitor(TPDM)
+==========================================================
 
     :Author:   Jinlong Mao <quic_jinlmao at quicinc.com>
     :Date:     January 2023
-- 
An old man doll... just what I always wanted! - Clara




More information about the linux-arm-kernel mailing list