zephyr/doc/services
Gerard Marull-Paretas 79e6b0e0f6 includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h>
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>
2022-09-05 16:31:47 +02:00
..
crypto doc: move crypto/random sections into os services 2022-04-07 16:35:19 +02:00
debugging debug: gdbstub: Move to DTS for uart device 2022-08-01 09:09:45 -07:00
device_mgmt doc: device_mgmt: smp: Add slot number to erase command 2022-09-02 10:56:58 +00:00
file_system doc: move file system into os services 2022-04-07 16:35:19 +02:00
logging logging: Remove logging v1 from the logging 2022-06-16 10:51:15 -04:00
modbus doc: get rid of reference section 2022-04-07 16:35:19 +02:00
pm docs: pm: Fix device pm documentation 2022-07-01 22:09:50 +02:00
portability lib: posix: add perror() implementation 2022-07-04 22:53:36 +02:00
resource_management doc: move resource management under services 2022-04-07 16:35:19 +02:00
rtio rtio: Real-Time Input/Output Stream 2022-06-28 13:53:13 -04:00
settings includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
shell doc: Fix links to Zephyr include directory on Github 2022-04-21 18:35:16 -04:00
smf includes: prefer <zephyr/kernel.h> over <zephyr/zephyr.h> 2022-09-05 16:31:47 +02:00
storage sdhc: dts: remove label property from SDHC nodes 2022-07-15 16:04:12 -05:00
task_wdt doc: move misc services into OS Service section 2022-04-07 16:35:19 +02:00
tfm doc: Fix spelling errors in .rst files 2022-04-19 11:48:26 +02:00
tracing tracing: add additional user tracing thread calls 2022-06-28 13:52:21 -04:00
usb devices: constify device pointers initialized at compile time 2022-08-22 17:08:26 +02:00
virtualization doc: get rid of reference section 2022-04-07 16:35:19 +02:00
formatted_output.rst doc: move formatted output under os services 2022-04-07 16:35:19 +02:00
index.rst rtio: Real-Time Input/Output Stream 2022-06-28 13:53:13 -04:00
misc.rst doc: get rid of reference section 2022-04-07 16:35:19 +02:00
notify.rst doc: move notification services under os services 2022-04-07 16:35:19 +02:00