zephyr/doc/guides
Marc Herbert 20c7ec4ad5 doc: west: add inline comments in the tree and manifest examples
It's great to have full manifest examples that can actually work as they
are, however the number of lines can "dilute" the feature currently
described and distract from it. Add some comments in the manifests to
highlight the current topic(s).

The file tree examples and their descriptions are carefully made up and
generally excellent, however I found my eyes going constantly back and
forth between the two in order to match them with one another and build
the actual, graphical representation in my head. These new comments
attached to the major elements of the trees will IMHO accelerate that
visual representation. What I found especially lacking: clues about
which directories are .git/ clones; a pity in the pages specifically
about git clone organization.

Signed-off-by: Marc Herbert <marc.herbert@intel.com>
2020-10-12 14:50:17 -05:00
..
bluetooth doc: update enumerator usage to :c:enumerator: 2020-08-31 09:57:33 -04:00
build
coding_guidelines doc: coding guidelines: fix links for other rules examples 2020-07-25 10:50:03 -04:00
crypto
debugging doc: debugging: Add information about gdbstub 2020-09-02 20:54:57 -04:00
device_mgmt dts: remove legacy macro support 2020-10-09 08:45:38 -05:00
documentation
dts dts: remove legacy macro support 2020-10-09 08:45:38 -05:00
kconfig cmake: extend support for conf file and board overlays 2020-09-04 17:52:27 +02:00
networking doc: net: Add information about net_pkt processing statistics 2020-08-07 10:12:51 +03:00
optimizations doc: add documentation for tool targets 2020-07-26 19:26:57 -04:00
platformio
portability doc: guides: portability: fix misspellings in POSIX C LANG table 2020-08-21 13:55:32 -04:00
porting doc: remove benchmarking section from docs 2020-09-05 13:28:38 -05:00
test sanitycheck: inclusive language 2020-08-27 07:04:07 -04:00
tools
tracing tracing: add feature for analysing post-mortem 2020-10-07 10:10:48 -04:00
west doc: west: add inline comments in the tree and manifest examples 2020-10-12 14:50:17 -05:00
beyond-GSG.rst
c_library.rst
coccinelle.rst
code-relocation.rst
coverage.rst doc: coverage: document unit test coverage 2020-10-06 18:08:19 -05:00
design_guidelines.rst doc: Apply constant qualifier on device instance where relevant 2020-09-02 13:48:13 +02:00
env_vars.rst
getting-help.rst
index.rst doc: guides: add design guidelines with callback expectations 2020-08-25 18:09:56 +02:00
modules.rst docs: Zephyr module and CMake processing 2020-08-31 12:15:02 +02:00
zephyr_cmake_package.rst cmake: Zephyr CMake package clean-up and minor fix 2020-08-19 12:52:33 -04:00