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
.. _nanopb_sample: Nanopb sample ############# Overview ******** A simple protocol buffer sample using Nanopb for serializing structured data to platform independent raw buffers or streams. Requirements ************ Nanopb uses the protocol buffer compiler to generate source and header files, make sure the ``protoc`` executable is installed and available. .. tabs:: .. group-tab:: Ubuntu Use ``apt`` to install dependency: .. code-block:: bash sudo apt install protobuf-compiler .. group-tab:: macOS Use ``brew`` to install dependency: .. code-block:: bash brew install protobuf .. group-tab:: Windows Use ``choco`` to install dependency: .. code-block:: console choco install protoc Building and Running ******************** This application can be built as follows: .. zephyr-app-commands:: :zephyr-app: samples/modules/nanopb :host-os: unix :board: qemu_x86 :goals: run :compact: