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
.. _bluetooth-hci-usb-h4-sample: Bluetooth: HCI H4 over USB ########################## Overview ******** Make a USB H4 Bluetooth dongle out of Zephyr. Requires USB device support from the board it runs on (e.g. :ref:`nrf52840dk_nrf52840` supports both BLE and USB). Requirements ************ * Bluetooth stack running on the host (e.g. BlueZ) * A board with Bluetooth and USB support in Zephyr Building and Running ******************** This sample can be found under :zephyr_file:`samples/bluetooth/hci_usb_h4` in the Zephyr tree. See :ref:`bluetooth samples section <bluetooth-samples>` for details.