From 513aa64873b85c626b2791659af60e9ce38e7042 Mon Sep 17 00:00:00 2001
From: Anas Nashif <anas.nashif@intel.com>
Date: Sat, 8 Dec 2018 14:00:39 -0500
Subject: [PATCH] doc: group logging and deprecate SYS_LOG_*

Group logging APIs and deprecate SYS_LOG_*

Signed-off-by: Anas Nashif <anas.nashif@intel.com>
---
 include/logging/log.h      | 7 +++++++
 include/logging/log_ctrl.h | 1 +
 include/logging/sys_log.h  | 7 +++++++
 3 files changed, 15 insertions(+)

diff --git a/include/logging/log.h b/include/logging/log.h
index d4d1d91dd0a..85d76d95577 100644
--- a/include/logging/log.h
+++ b/include/logging/log.h
@@ -14,6 +14,13 @@
 extern "C" {
 #endif
 
+/**
+ * @brief Logging
+ * @defgroup logging Logging
+ * @{
+ * @}
+ */
+
 /**
  * @brief Logger API
  * @defgroup log_api Logging API
diff --git a/include/logging/log_ctrl.h b/include/logging/log_ctrl.h
index c27868d71ef..f839dd10dbf 100644
--- a/include/logging/log_ctrl.h
+++ b/include/logging/log_ctrl.h
@@ -16,6 +16,7 @@ extern "C" {
 /**
  * @brief Logger
  * @defgroup logger Logger system
+ * @ingroup logging
  * @{
  * @}
  */
diff --git a/include/logging/sys_log.h b/include/logging/sys_log.h
index 7b13958c7e6..45b306356f4 100644
--- a/include/logging/sys_log.h
+++ b/include/logging/sys_log.h
@@ -33,6 +33,7 @@ extern "C" {
 /**
  * @brief System Log
  * @defgroup system_log System Log
+ * @ingroup logging
  * @{
  */
 #if defined(CONFIG_SYS_LOG) && (SYS_LOG_LEVEL > SYS_LOG_LEVEL_OFF)
@@ -134,6 +135,7 @@ void syslog_hook_install(void (*hook)(const char *, ...));
  *
  * @param ... A string optionally containing printk valid conversion specifier,
  * followed by as many values as specifiers.
+ * @deprecated Use LOG_ERR
  */
 #define SYS_LOG_ERR(...) { ; }
 #endif /* CONFIG_SYS_LOG */
@@ -151,6 +153,7 @@ void syslog_hook_install(void (*hook)(const char *, ...));
  *
  * @param ... A string optionally containing printk valid conversion specifier,
  * followed by as many values as specifiers.
+ * @deprecated Use LOG_WRN
  */
 #define SYS_LOG_WRN(...) { ; }
 #endif
@@ -166,6 +169,8 @@ void syslog_hook_install(void (*hook)(const char *, ...));
  *
  * @param ... A string optionally containing printk valid conversion specifier,
  * followed by as many values as specifiers.
+ *
+ * @deprecated Use LOG_INF
  */
 #define SYS_LOG_INF(...) { ; }
 #endif
@@ -181,6 +186,8 @@ void syslog_hook_install(void (*hook)(const char *, ...));
  *
  * @param ... A string optionally containing printk valid conversion specifier,
  * followed by as many values as specifiers.
+ *
+ * @deprecated Use LOG_DBG
  */
 #define SYS_LOG_DBG(...) { ; }
 #endif