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> |
||
|---|---|---|
| .. | ||
| fonts | ||
| src | ||
| CMakeLists.txt | ||
| prj.conf | ||
| README.rst | ||
| sample.yaml | ||
.. _cfb_custom_fonts: Custom Fonts ############ Overview ******** A simple example showing how to generate Character Framebuffer (CFB) font headers automatically at build time. This example generates a font with font elements for 6 sided dice from a PNG image, and then uses the generated header (``cfb_font_dice.h``) to show the font elements on the display of a supported board. The source code for this sample application can be found at: :zephyr_file:`samples/display/cfb_custom_font`. Building and Running ******************** There are different configuration files in the cfb_custom_font directory: - :file:`prj.conf` Generic config file, normally you should use this. - :file:`boards/reel_board.conf` This overlay config enables support for SSD16XX display controller on the reel_board. Example building for the reel_board with SSD16XX display support: .. zephyr-app-commands:: :zephyr-app: samples/subsys/display/cfb_custom_font :host-os: unix :board: reel_board :goals: flash :compact: