From b34e376e5196eddde8c0c80b994f89e433b3d139 Mon Sep 17 00:00:00 2001 From: Inaky Perez-Gonzalez Date: Tue, 28 Jun 2016 22:05:25 -0700 Subject: [PATCH] doc: update troubleshooting for Kconfig help Fix the omission of having bullets for the enumeration of options, as it makes the formatting look properly vs just different lines. Change-Id: I701f705bc03ccc2082439c3ea3c1b5053b2aac0a Signed-off-by: Inaky Perez-Gonzalez --- doc/contribute/doxygen/troubleshooting.rst | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/doc/contribute/doxygen/troubleshooting.rst b/doc/contribute/doxygen/troubleshooting.rst index c0f906e8576..50f6a5756ad 100644 --- a/doc/contribute/doxygen/troubleshooting.rst +++ b/doc/contribute/doxygen/troubleshooting.rst @@ -113,7 +113,8 @@ For example:: 0: Off. The ReST parser will be confused by the lack of blank lines between -the ``2``, ``1`` and ``0`` items, so help him by doing:: +the ``2``, ``1`` and ``0`` items, so help him by adding bullets and +spacing the lines:: config FAULT_DUMP int @@ -123,13 +124,13 @@ the ``2``, ``1`` and ``0`` items, so help him by doing:: help Different levels for display information when a fault occurs. - 2: The default. Display specific and verbose information. Consumes - the most memory (long strings). + - 2: The default. Display specific and verbose + information. Consumes the most memory (long strings). - 1: Display general and short information. Consumes less memory - (short strings). + - 1: Display general and short information. Consumes less + memory (short strings). - 0: Off. + - 0: Off. WARNING: Unparseable C++ cross-reference: u'struct somestruct'