You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
tools: dtsh: add dtsh to Zephyr extension commands overview
Add a brief entry to zephyr-cmds.rst to improve discoverability,
especially since west --help won't show the dtsh command.
Part of RFC zephyrproject-rtos#59863.
Signed-off-by: Christophe Dufaza <[email protected]>
Copy file name to clipboardExpand all lines: doc/develop/west/zephyr-cmds.rst
+52Lines changed: 52 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -428,3 +428,55 @@ each individual commit associated with the given pull request.
428
428
│ ├── second-commit-from-pr.patch
429
429
│ └── third-commit-from-pr.patch
430
430
└── patches.yml
431
+
432
+
The Devicetree Shell: ``west dtsh``
433
+
***********************************
434
+
435
+
DTSh is an interactive DTS files *viewer* with a shell-like command line interface: the devicetree is presented as a hierarchical file system, navigated and queried with familiar commands like ``cd``, ``ls``, ``tree`` or ``find``.
436
+
The shell has a rich user interface (contextual auto-completion, commands history, semantic highlighting, pager integration, user profiles), and can also execute commands or scripts non-interactively.
437
+
Commands output redirection permits to export custom views of the devicetree to text, HTML, or SVG files.
438
+
439
+
Please refer to the `DTSh manual`_ for detailed documentation.
440
+
441
+
``dtsh`` is provided by an optional Zephyr module project,
442
+
which interested users must install it explicitly:
443
+
444
+
.. code-block:: bash
445
+
446
+
# Enable and download optional West project.
447
+
west config manifest.project-filter -- +dtsh
448
+
west update
449
+
450
+
# Install module requirements.
451
+
west packages -m dtsh pip --install
452
+
453
+
454
+
Without argument, ``west dtsh`` will try to open the devicetree at :file:`build/zephy/zephyr.dts`:
455
+
456
+
.. code-block:: none
457
+
458
+
$ west build
459
+
$ west dtsh
460
+
dtsh (0.2.3): Shell-like interface with Devicetree
0 commit comments