From f7a1c23e1d9a5f736c3f6a86939e5ef42686d04b Mon Sep 17 00:00:00 2001
From: Holger Hans Peter Freyther <zecke@selfish.org>
Date: Tue, 22 Jun 2010 12:19:06 +0800
Subject: [PATCH] lchan: Document why lchan_reset is there... at least try to.

---
 openbsc/src/chan_alloc.c | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/openbsc/src/chan_alloc.c b/openbsc/src/chan_alloc.c
index c59c0a1f9..8115d8719 100644
--- a/openbsc/src/chan_alloc.c
+++ b/openbsc/src/chan_alloc.c
@@ -342,6 +342,11 @@ void lchan_free(struct gsm_lchan *lchan)
  * There was an error with the TRX and we need to forget
  * any state so that a lchan can be allocated again after
  * the trx is fully usable.
+ *
+ * This should be called after lchan_free to force a channel
+ * be available for allocation again. This means that this
+ * method will stop the "delay after error"-timer and set the
+ * state to LCHAN_S_NONE.
  */
 void lchan_reset(struct gsm_lchan *lchan)
 {