summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-16 14:37:31 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-16 14:37:31 +0200
commitdf8c57f328b350edee4fd59fb4a4b72ed2df1b23 (patch)
treea2e83ad03b5ed360c9296aefa4f723b0173c8199
parentefee361ce4639f5c1396569d55520b7cfe36179c (diff)
[doc] Introductory text on what the logging ring buffer is about
Change-Id: I876cd31e03a53ca90e658e353c0c8a839dece8ad
-rw-r--r--src/loggingrb.c7
1 files changed, 7 insertions, 0 deletions
diff --git a/src/loggingrb.c b/src/loggingrb.c
index b7d8d1fe..d3dd2543 100644
--- a/src/loggingrb.c
+++ b/src/loggingrb.c
@@ -22,6 +22,13 @@
/*! \addtogroup loggingrb
* @{
+ * This adds a log which consist of an in-memory ring buffer. The idea
+ * is that the user can configure his logging in a way that critical
+ * messages get stored in the ring buffer, and that the last few
+ * critical messages can then always obtained by dumping the ring
+ * buffer. It can hence be used as a more generic version of the
+ * "show me the last N alarms" functionality.
+ *
* \file loggingrb.c */
#include <osmocom/core/strrb.h>