zephyr/doc/guides/west
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
..
build-flash-debug.rst doc: update west build --pristine 2020-10-07 15:16:24 -05:00
config.rst doc: west: 'west installation' is now 'west workspace' 2020-02-25 23:08:02 +02:00
extensions.rst doc: west: 'west installation' is now 'west workspace' 2020-02-25 23:08:02 +02:00
index.rst doc: west: changes for v0.8 2020-10-01 20:47:53 +02:00
install.rst doc: west: Fix west completion docs 2019-08-12 09:44:37 -07:00
manifest.rst doc: west: add inline comments in the tree and manifest examples 2020-10-12 14:50:17 -05:00
moving-to-west.rst doc: west: 'west installation' is now 'west workspace' 2020-02-25 23:08:02 +02:00
release-notes.rst doc: west: fix typo in release notes 2020-10-06 09:12:41 -05:00
repo-tool.rst doc: west: add inline comments in the tree and manifest examples 2020-10-12 14:50:17 -05:00
sign.rst doc: west: update west sign documentation 2020-09-03 16:49:09 -05:00
troubleshooting.rst doc: west: troubleshoot no west on PATH on windows 2020-08-27 16:06:01 +02:00
west-apis.rst doc: west: changes for v0.8 2020-10-01 20:47:53 +02:00
west-mr-model.png
west-not-found.rst global: Remove leading/trailing blank lines in files 2019-12-11 19:17:27 +01:00
why.rst doc: move module related doc to guides 2019-05-21 21:45:00 -04:00
without-west.rst doc: west: 'west installation' is now 'west workspace' 2020-02-25 23:08:02 +02:00
zephyr-cmds.rst global: Remove leading/trailing blank lines in files 2019-12-11 19:17:27 +01:00