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 | ||
| prj.conf | ||
| README.rst | ||
| sample.yaml | ||
.. _sockets-net-mgmt-sample: Network Management Socket ######################### Overview ******** The net-mgmt-socket sample application for Zephyr implements a listener for network management events that the networking subsystem is sending. The source code for this sample application can be found at: :zephyr_file:`samples/net/sockets/net_mgmt`. Requirements ************ - :ref:`networking_with_host` Building and Running ******************** There are multiple ways to use this application. One of the most common usage scenario is to run echo-server application inside QEMU. This is described in :ref:`networking_with_qemu`. Build net-mgmt socket sample application like this: .. zephyr-app-commands:: :zephyr-app: samples/net/sockets/net_mgmt :board: <board to use> :conf: <config file to use> :goals: build :compact: Example building for the native_posix board: .. zephyr-app-commands:: :zephyr-app: samples/net/sockets/net_mgmt :host-os: unix :board: native_posix :conf: prj.conf :goals: run :compact: