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 | ||
| app.overlay | ||
| CMakeLists.txt | ||
| Kconfig | ||
| prj.conf | ||
| README.rst | ||
| sample.yaml | ||
.. _cdc-acm-console: Console over CDC ACM UART Sample ################################ Overview ******** A simple Hello World sample, with console output coming via CDC ACM UART. Primarily intended to show the required config options. Requirements ************ This project requires a USB device controller driver. Building and Running ******************** This sample can be built for multiple boards, in this example we will build it for the reel_board board: .. zephyr-app-commands:: :zephyr-app: samples/subsys/usb/console :board: reel_board :goals: flash :compact: Plug the board into a host device, for sample, a PC running Linux OS. The board will be detected as a CDC_ACM serial device. To see the console output from the sample, use a command similar to "minicom -D /dev/ttyACM0". .. code-block:: console Hello World! arm Hello World! arm Hello World! arm Hello World! arm Troubleshooting =============== You may need to stop modemmanager via "sudo stop modemmanager", if it is trying to access the device in the background.