ExternalVendorCode/genode
1
0
Fork 0
mirror of https://github.com/genodelabs/genode.git synced 2025-06-10 19:31:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

base: document error-message style conventions

Browse Source
This commit is contained in:
Norman Feske 2016-08-17 12:34:22 +02:00 committed by Christian Helmuth
parent 26a4534a37
commit 892f21fd54
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
repos/base/include/base/log.h
View File

@ -110,6 +110,10 @@ namespace Genode {
/** /**
* Write 'args' as a warning message to the log * Write 'args' as a warning message to the log
*
* The message is automatically prefixed with "Warning: ". Please refer to
* the description of the 'error' function regarding the convention of
* formatting error/warning messages.
*/ */
template <typename... ARGS> template <typename... ARGS>
void warning(ARGS &&... args) { Log::log().output(Log::WARNING, args...); } void warning(ARGS &&... args) { Log::log().output(Log::WARNING, args...); }
@ -117,6 +121,11 @@ namespace Genode {
/** /**
* Write 'args' as an error message to the log * Write 'args' as an error message to the log
*
* The message is automatically prefixed with "Error: ". Hence, the
* message argument does not need to additionally state that it is an error
* message. By convention, the actual message should be brief, starting
* with a lower-case character.
*/ */
template <typename... ARGS> template <typename... ARGS>
void error(ARGS &&... args) { Log::log().output(Log::ERROR, args...); } void error(ARGS &&... args) { Log::log().output(Log::ERROR, args...); }
@ -125,7 +134,7 @@ namespace Genode {
/** /**
* Write 'args' directly via the kernel (i.e., kernel debugger) * Write 'args' directly via the kernel (i.e., kernel debugger)
* *
* This function is intended for temporarly debugging purposes only. * This function is intended for temporarily debugging purposes only.
*/ */
template <typename... ARGS> template <typename... ARGS>
void raw(ARGS &&... args) { Raw::output(args...); } void raw(ARGS &&... args) { Raw::output(args...); }