* [PATCH 1/2] Documentation: coresight: Extend title heading syntax in TPDM and TPDA documentation
2023-01-21 4:00 ` [PATCH 0/2] Documentation: coresight: TPDM-TPDA doc fixes Bagas Sanjaya
@ 2023-01-21 4:00 ` Bagas Sanjaya
2023-01-21 4:00 ` [PATCH 2/2] Documentation: coresight: tpdm: Add dummy comment after sysfs list Bagas Sanjaya
1 sibling, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2023-01-21 4:00 UTC (permalink / raw)
To: CoreSight List, Linux ARM, Linux Documentation,
Linux Kernel Mailing List, oe-kbuild-all
Cc: Mathieu Poirier, Suzuki K Poulose, Mike Leach, Leo Yan,
Jonathan Corbet, Mao Jinlong, Bagas Sanjaya, kernel test robot
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@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@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@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@quicinc.com>
:Date: January 2023
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 3+ messages in thread* [PATCH 2/2] Documentation: coresight: tpdm: Add dummy comment after sysfs list
2023-01-21 4:00 ` [PATCH 0/2] Documentation: coresight: TPDM-TPDA doc fixes Bagas Sanjaya
2023-01-21 4:00 ` [PATCH 1/2] Documentation: coresight: Extend title heading syntax in TPDM and TPDA documentation Bagas Sanjaya
@ 2023-01-21 4:00 ` Bagas Sanjaya
1 sibling, 0 replies; 3+ messages in thread
From: Bagas Sanjaya @ 2023-01-21 4:00 UTC (permalink / raw)
To: CoreSight List, Linux ARM, Linux Documentation,
Linux Kernel Mailing List, oe-kbuild-all
Cc: Mathieu Poirier, Suzuki K Poulose, Mike Leach, Leo Yan,
Jonathan Corbet, Mao Jinlong, Bagas Sanjaya, kernel test robot
kernel test robot reported htmldocs warning:
Documentation/trace/coresight/coresight-tpdm.rst:43: WARNING: Document may not end with a transition.
Since there is no more documentation left for TPDM, fix the warning by adding
dummy comment, thus creating the required text transition.
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@intel.com>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
---
Documentation/trace/coresight/coresight-tpdm.rst | 2 ++
1 file changed, 2 insertions(+)
diff --git a/Documentation/trace/coresight/coresight-tpdm.rst b/Documentation/trace/coresight/coresight-tpdm.rst
index 6c6e95109072fa..72fd5c855d459a 100644
--- a/Documentation/trace/coresight/coresight-tpdm.rst
+++ b/Documentation/trace/coresight/coresight-tpdm.rst
@@ -41,3 +41,5 @@ Root: ``/sys/bus/coresight/devices/tpdm<N>``
value - 1 or 2.
----
+
+.. This text is intentionally added to make Sphinx happy.
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply related [flat|nested] 3+ messages in thread