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 | ||
| docker-test.sh | ||
| prj.conf | ||
| sample.yaml | ||
README.rst
.. _syslog-net-sample: Syslog net Application ###################### Overview ******** This sample application enables a remote syslog service that will send syslog messages to a remote server, as configured in ``prj.conf``. See https://tools.ietf.org/html/rfc5424 and https://tools.ietf.org/html/rfc5426 for more details about syslog protocol over UDP. The source code for this sample application can be found at: :zephyr_file:`samples/net/syslog_net`. Requirements ************ - :ref:`networking_with_host` Building and Running ******************** For configuring the remote IPv6 syslog server, set the following variables in prj.conf file: .. code-block:: console CONFIG_LOG_BACKEND_NET=y CONFIG_LOG_BACKEND_NET_SERVER="[2001:db8::2]:514" Default port number is 514 if user does not specify a value. The following syntax is supported for the server address and port: .. code-block:: console 192.0.2.1:514 192.0.2.42 [2001:db8::1]:514 [2001:db8::2] 2001:db::42 Build syslog_net sample application like this: .. zephyr-app-commands:: :zephyr-app: samples/net/syslog_net :board: <board to use> :conf: <config file to use> :goals: build :compact: