[doc] Introductory text on what the logging ring buffer is about

Change-Id: I876cd31e03a53ca90e658e353c0c8a839dece8ad

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>