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
.. _console_getline_sample: console_getline() Sample Application #################################### Overview ******** This example shows how to use :c:func:`console_getline` function. Similar to the well-known ANSI C gets() and fgets() functions, :c:func:`console_getline` either returns the next available input line or blocks waiting for one. Using this function, it should be fairly easy to port existing ANSI C, POSIX, or Linux applications which process console input line by line. The sample also allows to see details of how a line is returned by the function. If you are interested in character by character console input, see :ref:`console_getchar_sample`. Requirements ************ UART console is required to run this sample. Building and Running ******************** The easiest way to run this sample is using QEMU: .. zephyr-app-commands:: :zephyr-app: samples/subsys/console/getline :host-os: unix :board: qemu_x86 :goals: run :compact: Now start pressing keys on a keyboard, followed by Enter. The input line will be printed back, with a hex code of the last character, to show that line does not include any special "end of line" characters (like LF, CR, etc.) Exit QEMU by pressing :kbd:`CTRL+A` :kbd:`x`.