* [coresight:next 28/28] htmldocs: Documentation/trace/coresight/coresight-tpda.rst:3: WARNING: Title overline too short.
@ 2023-01-21 1:37 kernel test robot
2023-01-21 4:00 ` Bagas Sanjaya
0 siblings, 1 reply; 7+ messages in thread
From: kernel test robot @ 2023-01-21 1:37 UTC (permalink / raw)
To: Mao Jinlong; +Cc: oe-kbuild-all, Suzuki K Poulose, linux-doc
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 <lkp@intel.com>
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 <quic_jinlmao@quicinc.com>
8 :Date: January 2023
9
--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 0/2] Documentation: coresight: TPDM-TPDA doc fixes
2023-01-21 1:37 [coresight:next 28/28] htmldocs: Documentation/trace/coresight/coresight-tpda.rst:3: WARNING: Title overline too short kernel test robot
@ 2023-01-21 4:00 ` Bagas Sanjaya
0 siblings, 0 replies; 7+ 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
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/202301210955.zYxDrLgv-lkp@intel.com/
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
--
An old man doll... just what I always wanted! - Clara
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 0/2] Documentation: coresight: TPDM-TPDA doc fixes
@ 2023-01-21 4:00 ` Bagas Sanjaya
0 siblings, 0 replies; 7+ 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
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/202301210955.zYxDrLgv-lkp@intel.com/
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
--
An old man doll... just what I always wanted! - Clara
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply [flat|nested] 7+ messages in thread
* [PATCH 1/2] Documentation: coresight: Extend title heading syntax in TPDM and TPDA documentation
2023-01-21 4:00 ` Bagas Sanjaya
@ 2023-01-21 4:00 ` Bagas Sanjaya
-1 siblings, 0 replies; 7+ 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] 7+ messages in thread
* [PATCH 1/2] Documentation: coresight: Extend title heading syntax in TPDM and TPDA documentation
@ 2023-01-21 4:00 ` Bagas Sanjaya
0 siblings, 0 replies; 7+ 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
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply related [flat|nested] 7+ messages in thread
* [PATCH 2/2] Documentation: coresight: tpdm: Add dummy comment after sysfs list
2023-01-21 4:00 ` Bagas Sanjaya
@ 2023-01-21 4:00 ` Bagas Sanjaya
-1 siblings, 0 replies; 7+ 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] 7+ messages in thread
* [PATCH 2/2] Documentation: coresight: tpdm: Add dummy comment after sysfs list
@ 2023-01-21 4:00 ` Bagas Sanjaya
0 siblings, 0 replies; 7+ 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
_______________________________________________
linux-arm-kernel mailing list
linux-arm-kernel@lists.infradead.org
http://lists.infradead.org/mailman/listinfo/linux-arm-kernel
^ permalink raw reply related [flat|nested] 7+ messages in thread
end of thread, other threads:[~2023-01-21 4:01 UTC | newest]
Thread overview: 7+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2023-01-21 1:37 [coresight:next 28/28] htmldocs: Documentation/trace/coresight/coresight-tpda.rst:3: WARNING: Title overline too short kernel test robot
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 1/2] Documentation: coresight: Extend title heading syntax in TPDM and TPDA documentation 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
2023-01-21 4:00 ` Bagas Sanjaya
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.