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
.. _nrf_led_matrix_sample: nRF LED matrix sample ##################### Overview ******** This is a simple application intended to present the nRF LED matrix display driver in action and to serve as a test ensuring that this driver is buildable for both the :ref:`bbc_microbit_v2` and :ref:`bbc_microbit` boards. Requirements ************ The sample has been tested on the bbc_microbit_v2 and bbc_microbit boards, but it could be ported to any board with an nRF SoC and the proper number of GPIOs available for driving a LED matrix. To do it, one needs to add an overlay file with the corresponding ``"nordic,nrf-led-matrix"`` compatible node. Building and Running ******************** The code can be found in :zephyr_file:`samples/boards/nrf/nrf_led_matrix`. To build and flash the application: .. zephyr-app-commands:: :zephyr-app: samples/boards/nrf/nrf_led_matrix :board: bbc_microbit_v2 :goals: build flash :compact: