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 | ||
| Kconfig | ||
| README.rst | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _lldp-sample: LLDP Sample Application ####################### Overview ******** The Link Layer Discovery Protocol sample application for Zephyr will enable LLDP support and setup VLANs if needed. The source code for this sample application can be found at: :zephyr_file:`samples/net/lldp`. Requirements ************ - :ref:`networking_with_host` Building and Running ******************** A good way to run this sample LLDP application is inside QEMU, as described in :ref:`networking_with_qemu` or with embedded device like FRDM-K64F. Note that LLDP is only supported for boards that have an ethernet port. Follow these steps to build the LLDP sample application: .. zephyr-app-commands:: :zephyr-app: samples/net/lldp :board: <board to use> :conf: prj.conf :goals: build :compact: Setting up Linux Host ===================== If you need VLAN support in your network, then the :zephyr_file:`samples/net/vlan/vlan-setup-linux.sh` provides a script that can be executed on the Linux host. It creates two VLANs on the Linux host and creates routes to Zephyr.