RFC — DtSh, shell-like interface with Devicetree

doc/develop/west/dtsh/bib.rst

@@ -0,0 +1,223 @@
+:orphan:
+
+..
+   --------------------------------------------------------------------------------
+   Bibliography
+   --------------------------------------------------------------------------------
+
+..
+   Zephyr
+   --------------------------------------------------------------------------------
+
+.. _Zephyr-Getting Started:
+   https://docs.zephyrproject.org/latest/develop/getting_started/index.html
+
+.. _Zephyr-Device Driver Model:
+   https://docs.zephyrproject.org/latest/kernel/drivers/index.html#device-driver-model
+
+.. _Zephyr-Devicetree:
+   https://docs.zephyrproject.org/latest/build/dts/index.html
+
+.. _Zephyr-Devicetree Bindings:
+   https://docs.zephyrproject.org/latest/build/dts/bindings.html
+
+.. _Zephyr-Where Bindings Are Located:
+   https://docs.zephyrproject.org/latest/build/dts/bindings-intro.html#where-bindings-are-located
+
+.. _Zephyr-Binding Syntax:
+   https://docs.zephyrproject.org/latest/build/dts/bindings-syntax.html
+
+.. _Zephyr-Devicetree API:
+   https://docs.zephyrproject.org/latest/build/dts/api/api.html
+
+.. _Zephyr-Configuration Phase:
+   https://docs.zephyrproject.org/latest/build/cmake/index.html#configuration-phase
+
+.. _Zephyr-Kconfig:
+   https://docs.zephyrproject.org/latest/build/kconfig/index.html
+
+.. _Zephyr-DTS Compatibility:
+   https://docs.zephyrproject.org/latest/build/dts/design.html#source-compatibility-with-other-operating-systems
+
+.. _Zephyr-Devicetree Tooling:
+   https://github.com/zephyrproject-rtos/zephyr/tree/main/scripts/dts
+
+.. _Zephyr-python-devicetree:
+   https://github.com/zephyrproject-rtos/zephyr/tree/main/scripts/dts/python-devicetree
+
+.. _Zephyr-gen_defines.py:
+   https://github.com/zephyrproject-rtos/zephyr/blob/main/scripts/dts/gen_defines.py
+
+.. _Zephyr-West commands:
+   https://docs.zephyrproject.org/latest/develop/west/zephyr-cmds.html
+
+.. _Zephyr-West:
+   https://docs.zephyrproject.org/latest/develop/west/index.html
+
+.. _Zephyr-Boards:
+   https://docs.zephyrproject.org/latest/boards/index.html
+
+.. _Zephyr-Board Porting Guide:
+   https://docs.zephyrproject.org/latest/hardware/porting/board_porting.html#board-porting-guide
+
+.. _Zephyr-nRF52840 DK:
+   https://docs.zephyrproject.org/latest/boards/arm/nrf52840dk_nrf52840/doc/index.html
+
+.. _Zephyr-Devicetree Mysteries Solved:
+   https://www.youtube.com/watch?v=w8GgP3h0M8M
+
+..
+   Devicetree Specification
+   --------------------------------------------------------------------------------
+
+.. _Devicetree Specification:
+   https://devicetree-specification.readthedocs.io/en/latest/
+
+.. _DTSpec-DTS:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter6-source-language.html
+
+.. _DTSpec-DTB:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter5-flattened-format.html
+
+.. _DTSpec 2.2.1:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#node-names
+
+.. _DTSpec 2.2.3:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#path-names
+
+.. _DTSpec 2.2.4.1:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html#property-names
+
+.. _DTSpec 3.3:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter3-devicenodes.html#aliases-node
+
+.. _DTSpec 3.6:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter3-devicenodes.html#chosen-node
+
+.. _DTSpec 6.2:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter6-source-language.html#labels
+
+.. _DTSpec-The Devicetree:
+   https://devicetree-specification.readthedocs.io/en/latest/chapter2-devicetree-basics.html
+
+..
+   Linux
+   --------------------------------------------------------------------------------
+
+.. _Linux-Open Firmware and Devicetree:
+   https://www.kernel.org/doc/html/latest/devicetree/index.html
+
+.. _Linux-Devicetree Usage Model:
+   https://www.kernel.org/doc/html/latest/devicetree/usage-model.html
+
+.. _Linux-Writing Devicetree Bindings in json-schema:
+   https://www.kernel.org/doc/html/latest/devicetree/bindings/writing-schema.html
+
+.. _Linux-DeviceTree Kernel API:
+   https://www.kernel.org/doc/html/latest/devicetree/kernel-api.html
+
+..
+   DTSh
+   --------------------------------------------------------------------------------
+
+.. _DTSh-GitHub:
+   https://github.com/dottspina/dtsh/
+
+.. _DTSh-Install stand-alone:
+   https://github.com/dottspina/dtsh/blob/dtsh-next/README.md#stand-alone
+
+.. _DTSh-Install workspace:
+   https://github.com/dottspina/dtsh/blob/dtsh-next/README.md#west-workspace
+
+.. _DTSh-RFC:
+   https://github.com/zephyrproject-rtos/zephyr/pull/59863
+
+.. _DTSh-New Issue:
+   https://github.com/dottspina/dtsh/issues/new/choose
+
+.. _DTSh-Issue python-devicetree:
+   https://github.com/dottspina/dtsh/issues/2
+
+.. _DTSh-Issue gnureadline:
+   https://github.com/dottspina/dtsh/issues/3
+
+.. _DTSh-main:
+   https://github.com/dottspina/dtsh/tree/main
+
+.. _DTSh-User Guide:
+   https://github.com/dottspina/dtsh/blob/dtsh-next/doc/ug/DTSh.pdf
+
+..
+   PyPI
+   --------------------------------------------------------------------------------
+
+.. _PyPI-devicetree:
+   https://pypi.org/project/devicetree/
+
+.. _PyPI-dtsh:
+   https://pypi.org/project/dtsh/
+
+.. _PyPI-PyYAML:
+   https://pypi.org/project/PyYAML/
+
+.. _PyPI-rich:
+   https://pypi.org/project/rich/
+
+.. _PyPI-gnureadline:
+   https://pypi.org/project/gnureadline/
+
+..
+   Python
+   --------------------------------------------------------------------------------
+
+.. _Python readline:
+   https://docs.python.org/fr/3.8/library/readline.html
+
+..
+   Misc.
+   --------------------------------------------------------------------------------
+
+.. _GNU getopt:
+   https://www.gnu.org/software/libc/manual/html_node/Using-Getopt.html
+
+.. _GNU Readline library:
+   https://tiswww.cwru.edu/php/chet/readline/rltop.html
+
+.. _Editline:
+   https://thrysoee.dk/editline/
+
+.. _Bash History Facilities:
+   https://www.gnu.org/software/bash/manual/html_node/Bash-History-Facilities.html
+
+.. _Bindable Readline Commands:
+   https://www.gnu.org/software/bash/manual/html_node/Bindable-Readline-Commands.html
+
+.. _GNU Emacs Reference Card:
+   https://www.gnu.org/software/emacs/refcards/pdf/refcard.pdf
+
+.. _Readline Init File:
+   https://www.gnu.org/software/bash/manual/html_node/Readline-Init-File.html
+
+.. _Commands For Manipulating The History:
+   https://www.gnu.org/software/bash/manual/html_node/Commands-For-History.html
+
+.. _GNU less compiled for Windows:
+   https://github.com/jftuga/less-Windows
+
+.. _Web Safe Fonts:
+   https://www.w3schools.com/csSref/css_websafe_fonts.php
+
+.. _ANSI escape sequences:
+   https://en.wikipedia.org/wiki/ANSI_escape_code
+
+.. _OSC 8:
+   https://gist.github.com/egmontkob/eb114294efbcd5adb1944c9f3cb5feda
+
+.. _OSC 8 support for conhost and terminal:
+   https://github.com/microsoft/terminal/pull/7251
+
+.. _WSL:
+   https://learn.microsoft.com/en-us/windows/wsl/
+
+.. _Pygments styles:
+   https://pygments.org/styles/