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
.. _net-promiscuous-mode-sample: Promiscuous Mode Sample Application ################################### Overview ******** This application will enable promiscuous mode for every network interface in the system. It will then start to listen for incoming network packets and show information about them. The application will also provide a shell so that user can enable or disable promiscuous mode at runtime. The commands are called ``promisc on`` and ``promisc off``. Requirements ************ - :ref:`networking_with_host` Building and Running ******************** There are multiple ways to use this application. In this example QEMU is used: .. zephyr-app-commands:: :zephyr-app: samples/net/promiscuous_mode :board: qemu_x86 :conf: <config file to use> :goals: build :compact: