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.
This commit is contained in:
Romain Vimont 2022-02-01 21:35:02 +01:00
parent c8d0f5cdeb
commit 9b4360b6b8

View file

@ -7,6 +7,8 @@
/** /**
* Parse the ip from the output of `adb shell ip route` * Parse the ip from the output of `adb shell ip route`
*
* Warning: this function modifies the buffer for optimization purposes.
*/ */
char * char *
sc_adb_parse_device_ip_from_output(char *buf, size_t buf_len); sc_adb_parse_device_ip_from_output(char *buf, size_t buf_len);