Skip to content

Commit d38bfab

Browse files
kkasperczyk-noArekBalysNordic
authored andcommitted
doc: Fixed logs for matter diagnostic logs snippet
The documentation for matter diagnostic logs snippet contains invalid snippet name. Signed-off-by: Kamil Kasperczyk <[email protected]>
1 parent 7666fb4 commit d38bfab

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

doc/nrf/protocols/matter/end_product/test_event_triggers.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -81,21 +81,21 @@ The following table lists the available triggers and their activation codes:
8181
The maximum time is UINT16_MAX s.
8282
The value is provided in HEX format.
8383
* - Diagnostic Logs User Data
84-
- Enabled ``Diagnostic Logs`` cluster, and either the snippet ``matter-diagnostic-logs`` attached (``-D<application_name>_SNIPPET=matter-diagnostic-logs``) or both :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS>` = ``y`` and :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_END_USER_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_END_USER_LOGS>` = ``y``.
84+
- Enabled ``Diagnostic Logs`` cluster, and either the snippet ``diagnostic-logs`` attached (``-D<application_name>_SNIPPET=diagnostic-logs``) or both :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS>` = ``y`` and :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_END_USER_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_END_USER_LOGS>` = ``y``.
8585
- Trigger writing a specific number of ``u`` characters to the user diagnostics logs.
8686
The number of characters is determined by the value at the end of the event trigger value.
8787
The current supported maximum is 1023 bytes for single trigger call, and 4096 bytes of total data written.
8888
- ``0xFFFFFFFF40000000`` - ``0xFFFFFFFF40000400``
8989
- The range of ``0x0000`` - ``0x0400`` (from 1 Bytes to 1024 Bytes), ``0x0000`` to clear logs.
9090
* - Diagnostic Logs Network Data
91-
- Enabled ``Diagnostic Logs`` cluster, and either the snippet ``matter-diagnostic-logs`` attached (``-D<application_name>_SNIPPET=matter-diagnostic-logs``) or both :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS>` = ``y`` and :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_NETWORK_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_NETWORK_LOGS>` = ``y``.
91+
- Enabled ``Diagnostic Logs`` cluster, and either the snippet ``diagnostic-logs`` attached (``-D<application_name>_SNIPPET=diagnostic-logs``) or both :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS>` = ``y`` and :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_NETWORK_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_NETWORK_LOGS>` = ``y``.
9292
- Trigger writing a specific number of ``n`` characters to the network diagnostics logs.
9393
The number of characters is determined by the value at the end of the event trigger value.
9494
The current supported maximum is 1023 bytes for single trigger call, and 4096 bytes of total data written.
9595
- ``0xFFFFFFFF50000000`` - ``0xFFFFFFFF50000400``
9696
- The range of ``0x0000`` - ``0x0400`` (from 1 Bytes to 1024 Bytes), ``0x0000`` to clear logs.
9797
* - Diagnostic Crash Logs
98-
- Either the snippet ``matter-diagnostic-logs`` attached (``-D<application_name>_SNIPPET=matter-diagnostic-logs``) or both :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS>` = ``y`` and :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_CRASH_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_CRASH_LOGS>` = ``y``, and enabled ``Diagnostic Logs`` cluster.
98+
- Either the snippet ``diagnostic-logs`` attached (``-D<application_name>_SNIPPET=diagnostic-logs``) or both :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS>` = ``y`` and :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_CRASH_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS_CRASH_LOGS>` = ``y``, and enabled ``Diagnostic Logs`` cluster.
9999
- Trigger a simple crash that relies on execution of the undefined instruction attempt.
100100
- ``0xFFFFFFFF60000000``
101101
- No additional value supported.

doc/nrf/protocols/matter/getting_started/advanced_kconfigs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -318,14 +318,14 @@ Deferred logs mode (:kconfig:option:`CONFIG_LOG_MODE_DEFERRED`) is enabled becau
318318
You cannot set the :ref:`CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS<CONFIG_NCS_SAMPLE_MATTER_DIAGNOSTIC_LOGS>` Kconfig option separately without adding the devicetree overlays contained in the snippet.
319319
Instead, if you want to use just some of the diagnostic logs functionality, use the snippet and set the Kconfig options for the other functionalities to ``n``.
320320

321-
To use the snippet when building a sample, add ``-D<project_name>_SNIPPET=matter-diagnostic-logs`` to the west arguments list.
321+
To use the snippet when building a sample, add ``-D<project_name>_SNIPPET=diagnostic-logs`` to the west arguments list.
322322

323323
Example for the ``nrf52840dk/nrf52840`` board target and the :ref:`matter_lock_sample` sample:
324324

325325
.. parsed-literal::
326326
:class: highlight
327327
328-
west build -b nrf52840dk/nrf52840 -- -Dlock_SNIPPET=matter-diagnostic-logs
328+
west build -b nrf52840dk/nrf52840 -- -Dlock_SNIPPET=diagnostic-logs
329329
330330
.. _ug_matter_debug_snippet:
331331

samples/matter/common/config.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -238,13 +238,13 @@ The snippets are in the :file:`nrf/snippets` directory of the |NCS|.
238238
For more information about using snippets, see :ref:`zephyr:using-snippets` in the Zephyr documentation.
239239

240240
Specify the corresponding snippet names in the :makevar:`SNIPPET` CMake option for the application configuration.
241-
The following is an example command for the ``nrf52840dk/nrf52840`` board target that adds the ``matter-diagnostic-logs`` snippet to the :ref:`matter_lock_sample` sample:
241+
The following is an example command for the ``nrf52840dk/nrf52840`` board target that adds the ``diagnostic-logs`` snippet to the :ref:`matter_lock_sample` sample:
242242

243243
.. code-block::
244244
245-
west build -b nrf52840dk/nrf52840 -- -Dlock_SNIPPET=matter-diagnostic-logs
245+
west build -b nrf52840dk/nrf52840 -- -Dlock_SNIPPET=diagnostic-logs
246246
247247
The following snippets are available:
248248

249-
* ``matter-diagnostic-logs`` - Enables the set of configurations needed for full Matter diagnostic logs support.
249+
* ``diagnostic-logs`` - Enables the set of configurations needed for full Matter diagnostic logs support.
250250
See :ref:`ug_matter_diagnostic_logs_snippet` in the Matter protocol section for more information.

0 commit comments

Comments
 (0)