zephyrproject-rtos / zephyr

Primary Git Repository for the Zephyr Project. Zephyr is a new generation, scalable, optimized, secure RTOS for multiple hardware architectures.
https://docs.zephyrproject.org
Apache License 2.0
10.82k stars 6.6k forks source link

doc: Documentation issue in 'build/dts/intro-input-output' #79535

Open LysandrosAn opened 4 weeks ago

LysandrosAn commented 4 weeks ago

Describe the bug

The middle white circle reads "Devicetree scripts in scripts/dts/". For a reader, the two arrows from above pointing into this circle might be interpreted as editing this directory which however is based in the main Zephyr directory. So for a beginner this diagram can be interpreted as zephyr.dts.pre changing files inside the Zephyr main directory, which appears to not be true. Also: the comment at the bottom left yellow field reads "build/zephyr/include/generated/zephyr": However if you build the "blinky" example, then the last folder zephyr doesn't exist in the "generated" folder. The latter only contains two more subfolders, namely libc and syscalls but no further zephyr subfolder.

<< You may also want to update the automatically generated issue title above. >>

Environment

nordicjm commented 4 weeks ago

Works for me:

/tmp/aa/zephyr/samples/basic/blinky/_AA$ ls zephyr/include/generated/zephyr/
autoconf.h              driver-validation.h  offsets.h        otype-to-str.h      syscall_export_llext.c  syscalls
devicetree_generated.h  kobj-types-enum.h    otype-to-size.h  syscall_dispatch.c  syscall_list.h          version.h

The part in the middle where it mentions scripts/dts does mean in the zephyr repo: https://github.com/zephyrproject-rtos/zephyr/tree/main/scripts/dts