From 9b4360b6b8e1ba4234f5b11b8217379faafcb3b7 Mon Sep 17 00:00:00 2001
From: Romain Vimont <rom@rom1v.com>
Date: Tue, 1 Feb 2022 21:35:02 +0100
Subject: [PATCH] Add warning in function documentation

The function parsing "ip route" output modifies the input buffer to
tokenize in place. This must be mentioned in the function documentation.
---
 app/src/adb_parser.h | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/app/src/adb_parser.h b/app/src/adb_parser.h
index 79f26631..ed7363d1 100644
--- a/app/src/adb_parser.h
+++ b/app/src/adb_parser.h
@@ -7,6 +7,8 @@
 
 /**
  * Parse the ip from the output of `adb shell ip route`
+ *
+ * Warning: this function modifies the buffer for optimization purposes.
  */
 char *
 sc_adb_parse_device_ip_from_output(char *buf, size_t buf_len);