alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

Fixed confused Sphinx

Browse Source 
Sphinx failed to phrase esp_log_timestamp
reorderdering esp_log_write and esp_log_timestamp fixed this issue
This commit is contained in:
Krzysztof 2016-10-29 23:15:27 +02:00 committed by Ivan Grokhotkov
parent f6118c67b0
commit 079f5faad8
2 changed files with 12 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
components/log/include/esp_log.h
View File

@ -29,7 +29,7 @@ extern "C" {
*/ */
typedef enum { typedef enum {
ESP_LOG_NONE, /*!< No log output */ ESP_LOG_NONE, /*!< No log output */
ESP_LOG_ERROR, /*!< Critical errors, software module can not recover on its own */ ESP_LOG_ERROR, /*!< Critical errors, software module can not recover on its own */
ESP_LOG_WARN, /*!< Error conditions from which recovery measures have been taken */ ESP_LOG_WARN, /*!< Error conditions from which recovery measures have been taken */
ESP_LOG_INFO, /*!< Information messages which describe normal flow of events */ ESP_LOG_INFO, /*!< Information messages which describe normal flow of events */
ESP_LOG_DEBUG, /*!< Extra information which is not necessary for normal use (values, pointers, sizes, etc). */ ESP_LOG_DEBUG, /*!< Extra information which is not necessary for normal use (values, pointers, sizes, etc). */
@ -60,17 +60,6 @@ void esp_log_level_set(const char* tag, esp_log_level_t level);
*/ */
void esp_log_set_vprintf(vprintf_like_t func); void esp_log_set_vprintf(vprintf_like_t func);
/**
* @brief Write message into the log
*
* This function is not intended to be used directly. Instead, use one of
* ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV macros.
*
* This function or these macros should not be used from an interrupt.
*/
void esp_log_write(esp_log_level_t level, const char* tag, const char* format, ...) __attribute__ ((format (printf, 3, 4)));
/** /**
* @brief Function which returns timestamp to be used in log output * @brief Function which returns timestamp to be used in log output
* *
@ -85,6 +74,16 @@ void esp_log_write(esp_log_level_t level, const char* tag, const char* format, .
*/ */
uint32_t esp_log_timestamp(void); uint32_t esp_log_timestamp(void);
/**
* @brief Write message into the log
*
* This function is not intended to be used directly. Instead, use one of
* ESP_LOGE, ESP_LOGW, ESP_LOGI, ESP_LOGD, ESP_LOGV macros.
*
* This function or these macros should not be used from an interrupt.
*/
void esp_log_write(esp_log_level_t level, const char* tag, const char* format, ...) __attribute__ ((format (printf, 3, 4)));
#if CONFIG_LOG_COLORS #if CONFIG_LOG_COLORS
#define LOG_COLOR_BLACK "30" #define LOG_COLOR_BLACK "30"

3
docs/api/log.rst
View File

@ -13,8 +13,7 @@ Functions
.. doxygenfunction:: esp_log_level_set .. doxygenfunction:: esp_log_level_set
.. doxygenfunction:: esp_log_set_vprintf .. doxygenfunction:: esp_log_set_vprintf
.. doxygenfunction:: esp_log_timestamp
.. doxygenfunction:: esp_log_write .. doxygenfunction:: esp_log_write
.. FIXME esp_log_timestamp