summaryrefslogtreecommitdiffstats
path: root/doc/develop/logging.rst
Commit message (Collapse)AuthorAgeFilesLines
* log: Add return-checking macros for 0 being successSimon Glass2021-03-121-1/+14
| | | | | | | | The existing log_ret() and log_msg_ret() macros consider an error to be less than zero. But some function may return a positive number to indicate a different kind of failure. Add macros to check for that also. Signed-off-by: Simon Glass <sjg@chromium.org>
* log: Handle line continuationSimon Glass2021-03-121-0/+16
| | | | | | | | | | | | | | | | When multiple log() calls are used which don't end in newline, the log prefix is prepended multiple times in the same line. This makes the output look strange. Fix this by detecting when the previous log record did not end in newline. In that case, setting a flag. Drop the unused BUFFSIZE in the test while we are here. As an example implementation, update log_console to check the flag and produce the expected output. Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: fix doc/develop/logging.rstHeinrich Schuchardt2021-01-271-10/+3
| | | | | | | | | | Sphinx 3 builds fail due to doc/develop/logging.rst producing duplicate labels. Include logging.h only once in the API section and use cross-references for the enums log_level_t and log_category_t. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
* doc: Update logging documentationSean Anderson2020-10-301-114/+107
| | | | | | | | | This updates logging documentation with some examples of the new commands added in the previous commits. It also removes some items from the to-do list which have been implemented. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
* doc: Add log kerneldocs to documentationSean Anderson2020-10-301-0/+5
| | | | | | | | The functions in log.h are already mostly documented, so add them to the generated documentation. Signed-off-by: Sean Anderson <seanga2@gmail.com> Reviewed-by: Simon Glass <sjg@chromium.org>
* log: allow for message continuationHeinrich Schuchardt2020-10-271-0/+6
| | | | | | | | | | | | | | | | Some drivers use macro pr_cont() for continuing a message sent via printk. Hence if we want to convert printk messaging to using the logging system, we must support continuation of log messages too. As pr_cont() does not provide a message level we need a means of remembering the last log level. With the patch a pseudo log level LOGL_CONT as well as a pseudo log category LOGC_CONT are introduced. Using these results in the application of the same log level and category as in the previous log message. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>
* log: Tidy up documentationSimon Glass2020-10-221-5/+8
| | | | | | | | | Fix up the documentation which was lost in a merge conflict in the conversion to RST. Fixes: 52d3df7fefe ("log: Allow LOG_DEBUG to always enable log output") Signed-off-by: Simon Glass <sjg@chromium.org>
* doc: move README.log to HTML documentationHeinrich Schuchardt2020-06-111-0/+290
Convert README.log to reStructuredText and add it to the generated HTML documentation. Assign doc/develop/logging.rst to the maintainer of LOGGING. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de> Reviewed-by: Simon Glass <sjg@chromium.org>