[PATCH] libosmocore[master]: [doc] Introductory text on what the logging ring buffer is a...

Harald Welte gerrit-no-reply at lists.osmocom.org
Mon Oct 16 12:53:48 UTC 2017


Review at  https://gerrit.osmocom.org/4288

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

Change-Id: I876cd31e03a53ca90e658e353c0c8a839dece8ad
---
M src/loggingrb.c
1 file changed, 7 insertions(+), 0 deletions(-)


  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/88/4288/1

diff --git a/src/loggingrb.c b/src/loggingrb.c
index b7d8d1f..d3dd254 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>

-- 
To view, visit https://gerrit.osmocom.org/4288
To unsubscribe, visit https://gerrit.osmocom.org/settings

Gerrit-MessageType: newchange
Gerrit-Change-Id: I876cd31e03a53ca90e658e353c0c8a839dece8ad
Gerrit-PatchSet: 1
Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Owner: Harald Welte <laforge at gnumonks.org>


More information about the gerrit-log mailing list