79e6b0e0f6
As of today <zephyr/zephyr.h> is 100% equivalent to <zephyr/kernel.h>. This patch proposes to then include <zephyr/kernel.h> instead of <zephyr/zephyr.h> since it is more clear that you are including the Kernel APIs and (probably) nothing else. <zephyr/zephyr.h> sounds like a catch-all header that may be confusing. Most applications need to include a bunch of other things to compile, e.g. driver headers or subsystem headers like BT, logging, etc. The idea of a catch-all header in Zephyr is probably not feasible anyway. Reason is that Zephyr is not a library, like it could be for example `libpython`. Zephyr provides many utilities nowadays: a kernel, drivers, subsystems, etc and things will likely grow. A catch-all header would be massive, difficult to keep up-to-date. It is also likely that an application will only build a small subset. Note that subsystem-level headers may use a catch-all approach to make things easier, though. NOTE: This patch is **NOT** removing the header, just removing its usage in-tree. I'd advocate for its deprecation (add a #warning on it), but I understand many people will have concerns. Signed-off-by: Gerard Marull-Paretas <gerard.marull@nordicsemi.no> |
||
|---|---|---|
| .. | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _display-ft800-sample: FT800 ##### Overview ******** This sample displays a hello message and an incrementing counter using FT800 Embedded Video Engine. Requirements ************ To use this sample, the following hardware is required: * A board with SPI support * Display with `FT800 EVE`_ like `VM800C board`_ Wiring ****** You will need to connect the `FT800 EVE`_ SPI interface onto a board that supports Arduino shields. Building and Running ******************** This sample should work on any board that has SPI enabled and has an Arduino shield interface. For example, it can be run on the nRF52840-DK board as described below: .. zephyr-app-commands:: :zephyr-app: samples/drivers/misc/ft800 :board: nrf52840dk_nrf52840 :goals: flash :compact: To build the sample for `VM800C board`_ the shield must be defined as described below: .. zephyr-app-commands:: :zephyr-app: samples/drivers/misc/ft800 :board: nrf52840dk_nrf52840 :shield: ftdi_vm800c :goals: flash :compact: .. _VM800C board: https://www.ftdichip.com/Products/Modules/VM800C.html .. _FT800 EVE: https://www.ftdichip.com/Products/ICs/FT800.html