gsm0808: comment about difference of gsm0808_create_clear_command()
This single function has a quite different behavior than the other
gsm0808_ functions in terms of how the resulting msgb l3h
pointers are set. Let's document that to avoid more confusion.
Change-Id: I0367760a588fc968c5a2dea46001ef1ee7965c8c
diff --git a/src/gsm/gsm0808.c b/src/gsm/gsm0808.c
index 86b6c05..4873076 100644
--- a/src/gsm/gsm0808.c
+++ b/src/gsm/gsm0808.c
@@ -178,7 +178,10 @@
return msg;
}
-/*! Create BSSMAP Clear Command message
+/*! Create BSSMAP Clear Command message with BSSAP header *before* l3h and BSSMAP in l3h.
+ * This is quite different from most (all?) other gsm0808_create_* which have l3h
+ * point to the BSSAP header. However, we have to keep this for backwards compatibility.
+ * Use gsm0808_create_clear_command2() for a 'modern' implementation.
* \param[in] cause TS 08.08 cause value
* \returns callee-allocated msgb with BSSMAP Clear Command message */
struct msgb *gsm0808_create_clear_command(uint8_t cause)