Skip to contentSkip to conversation

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

PATCH New kernel test robot 2 participants 4 messages Jan 21, 2023

Subsystems (2)
lore
Share & tools
lore

kernel test robot

author build bot
#0 lore raw
tree:   https://git.kernel.org/pub/scm/linux/kernel/git/coresight/linux.git next
head:   758d638667d474ff6b0a9052a8298f04c7ddf62f
commit: 758d638667d474ff6b0a9052a8298f04c7ddf62f [28/28] Documentation: trace: Add documentation for TPDM and TPDA
reproduce:
        # https://git.kernel.org/pub/scm/linux/kernel/git/coresight/linux.git/commit/?id=758d638667d474ff6b0a9052a8298f04c7ddf62f
        git remote add coresight https://git.kernel.org/pub/scm/linux/kernel/git/coresight/linux.git
        git fetch --no-tags coresight next
        git checkout 758d638667d474ff6b0a9052a8298f04c7ddf62f
        make menuconfig
        # enable CONFIG_COMPILE_TEST, CONFIG_WARN_MISSING_DOCUMENTS, CONFIG_WARN_ABI_ERRORS
        make htmldocs

If you fix the issue, kindly add following tag where applicable | Reported-by: kernel test robot <[email protected]>

All warnings (new ones prefixed by >>):

>> Documentation/trace/coresight/coresight-tpda.rst:3: WARNING: Title overline too short.
>> Documentation/trace/coresight/coresight-tpdm.rst:3: WARNING: Title overline too short.
>> Documentation/trace/coresight/coresight-tpdm.rst:43: WARNING: Document may not end with a transition.

vim +3 Documentation/trace/coresight/coresight-tpda.rst

     2	
   > 3	==============================
     4	The trace performance monitoring and diagnostics aggregator(TPDA).
     5	==============================
     6	
     7	    :Author:   Jinlong Mao <[email protected]>
     8	    :Date:     January 2023
     9	
Signature · 2 lines
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
#1 lore raw

cover Documentation: coresight: TPDM-TPDA doc fixes

Here are documentation fixes for TPDM and TPDA documentation, as reported recently by kernel test robot [1]. The patch description below is self-explanatory.

[1]: https://lore.kernel.org/linux-doc/[email protected]/

Bagas Sanjaya (2):
Documentation: coresight: Extend title heading syntax in TPDM and TPDA
documentation
Documentation: coresight: tpdm: Add dummy comment after sysfs list

 Documentation/trace/coresight/coresight-tpda.rst | 6 +++---
 Documentation/trace/coresight/coresight-tpdm.rst | 8 +++++---
 2 files changed, 8 insertions(+), 6 deletions(-)

base-commit: 758d638667d474ff6b0a9052a8298f04c7ddf62f

Signature · 1 line
An old man doll... just what I always wanted! - Clara
#2 lore raw

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

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.

Fixes 758d638667d474 ("Documentation: trace: Add documentation for TPDM and TPDA")
---
 Documentation/trace/coresight/coresight-tpda.rst | 6 +++---
 Documentation/trace/coresight/coresight-tpdm.rst | 6 +++---
 2 files changed, 6 insertions(+), 6 deletions(-)
Documentation/trace/coresight/coresight-tpda.rst +3 -3
index 350dad4eda4721..a37f387ceaea13 100644
@@ -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 <[email protected]>
     :Date:     January 2023
Documentation/trace/coresight/coresight-tpdm.rst +3 -3
index 4ba40b0db550da..6c6e95109072fa 100644
@@ -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 <[email protected]>
     :Date:     January 2023
Signature · 1 line
An old man doll... just what I always wanted! - Clara
#3 lore raw

PATCH 2/2 Documentation: coresight: tpdm: Add dummy comment after sysfs list

In reply to Bagas Sanjaya

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.

Fixes 758d638667d474 ("Documentation: trace: Add documentation for TPDM and TPDA")
---
 Documentation/trace/coresight/coresight-tpdm.rst | 2 ++
 1 file changed, 2 insertions(+)
Documentation/trace/coresight/coresight-tpdm.rst +2 -0
index 6c6e95109072fa..72fd5c855d459a 100644
@@ -41,3 +41,5 @@ Root: ``/sys/bus/coresight/devices/tpdm<N>``
     value -  1 or 2.
 
 ----
+
+.. This text is intentionally added to make Sphinx happy.
Signature · 1 line
An old man doll... just what I always wanted! - Clara