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> |
||
|---|---|---|
| .. | ||
| boards | ||
| dts/bindings | ||
| src | ||
| CMakeLists.txt | ||
| README.rst | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _microbit_line_follower_robot: BBC micro:bit line-follower robot ################################# Overview ******** This sample controls a stand-alone line-following DFRobot Maqueen robot chassis containing a BBC micro:bit board. Requirements ************ To build and run this sample you'll need a `DFRobot Maqueen robot chassis (ROB0148) <https://www.dfrobot.com/product-1783.html>`_ with a BBC micro:bit board. Use black tape to create a line track for the robot to follow. Build and flash the program to the BBC micro:bit board (described below), turn on the robot, and put it on the black line track. Building and running ******************** Build and flash this sample project using these commands: .. zephyr-app-commands:: :zephyr-app: samples/boards/bbc_microbit/line_follower_robot :board: bbc_microbit :goals: build flash :compact: Sample Output ************* The sample program controls the robot to follow a line track and does not write to the console. You can watch this `robot video`_ to see it in action. .. _robot video: https://youtu.be/tIvoHQjo8a4