From 40a73ec96e7eb2fd6b5c9f1070bf1a43f378c6d5 Mon Sep 17 00:00:00 2001 From: Gerard Marull-Paretas Date: Mon, 28 Oct 2024 09:02:17 +0100 Subject: [PATCH] snippets: rtt-console: fix README issues - Title underline too long - Remove redundant how-to-use snippet bit, this can be documented generically for all snippets instead of repeating it everywhere. - Snippet does not redirect anything. - RTT does not require HW support for console. Signed-off-by: Gerard Marull-Paretas --- snippets/rtt-console/README.rst | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/snippets/rtt-console/README.rst b/snippets/rtt-console/README.rst index 68a1f1baf5a..ec53ea694cb 100644 --- a/snippets/rtt-console/README.rst +++ b/snippets/rtt-console/README.rst @@ -1,21 +1,16 @@ .. _snippet-rtt-console: RTT Console Snippet (rtt-console) -######################################### - -.. code-block:: console - - west build -S rtt-console [...] +################################# Overview ******** -This snippet redirects serial console output to SEGGER RTT. +This snippet enables console output to SEGGER RTT. Requirements ************ -Hardware support for: +Support for: - :kconfig:option:`CONFIG_HAS_SEGGER_RTT` -- :kconfig:option:`CONFIG_CONSOLE`