summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorHarald Welte <laforge@gnumonks.org>2017-10-16 14:33:11 +0200
committerHarald Welte <laforge@gnumonks.org>2017-10-16 14:33:11 +0200
commit096a666712ae255ba919dd8e5f38c68a948f97bc (patch)
treeab850ee79fd1d9a78cc80cc5e19d77386eca66f0
parent197a4ac06d2bb84c7fa3232f78a9e45f9d58e53e (diff)
[doc] Doxygen documentation on osmo_hexdump print buffer size
Change-Id: I83ca2a3a555e5b3c1b7f23bf9e463a5063a8006c
-rw-r--r--src/utils.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/src/utils.c b/src/utils.c
index b4345c74..534916b6 100644
--- a/src/utils.c
+++ b/src/utils.c
@@ -235,6 +235,9 @@ char *osmo_ubit_dump(const uint8_t *bits, unsigned int len)
*
* This function will print a sequence of bytes as hexadecimal numbers,
* adding one space character between each byte (e.g. "1a ef d9")
+ *
+ * The maximum size of the output buffer is 4096 bytes, i.e. the maximum
+ * number of input bytes that can be printed in one call is 1365!
*/
char *osmo_hexdump(const unsigned char *buf, int len)
{
@@ -248,6 +251,9 @@ char *osmo_hexdump(const unsigned char *buf, int len)
*
* This function will print a sequence of bytes as hexadecimal numbers,
* without any space character between each byte (e.g. "1aefd9")
+ *
+ * The maximum size of the output buffer is 4096 bytes, i.e. the maximum
+ * number of input bytes that can be printed in one call is 2048!
*/
char *osmo_hexdump_nospc(const unsigned char *buf, int len)
{