Skip to content

Commit b6425b9

Browse files
doc: dts: adjust CONFIG_COMPILER_TRACK_MACRO_EXPANSION text
Rework to address some grammar issues and typos in the original. Signed-off-by: Martí Bolívar <[email protected]>
1 parent b004224 commit b6425b9

File tree

1 file changed

+10
-7
lines changed

1 file changed

+10
-7
lines changed

doc/build/dts/troubleshooting.rst

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -292,13 +292,16 @@ after preprocessing.
292292
Do not track macro expansion
293293
****************************
294294

295-
The compiler error message chain can quickly grow when making a mistake and
296-
using devicetree macros. In some situations, the number of compiler error
297-
messages can be overwhelming, specially because many not relevant internals are
298-
exposed. This happens because of long macro expansion chains. You may disable
299-
the :kconfig:option:`CONFIG_COMPILER_TRACK_MACRO_EXPANSION` option to skip macro
300-
expansion, typically reducing the error messages to one line. For example, to
301-
build :ref:`hello_world` with west and this option set, use:
295+
Compiler messages for devicetree errors can sometimes be very long. This
296+
typically happens when the compiler prints a message for every step of a
297+
complex macro expansion that has several intermediate expansion steps.
298+
299+
To prevent the compiler from doing this, you can disable the
300+
:kconfig:option:`CONFIG_COMPILER_TRACK_MACRO_EXPANSION` option. This typically
301+
reduces the output to one message per error.
302+
303+
For example, to build :ref:`hello_world` with west and this option disabled,
304+
use:
302305

303306
.. code-block:: sh
304307

0 commit comments

Comments
 (0)