Change in libosmocore[master]: fix api doc of osmo_identifier_sanitize_buf()

neels gerrit-no-reply at lists.osmocom.org
Wed Jul 7 21:52:53 UTC 2021


neels has uploaded this change for review. ( https://gerrit.osmocom.org/c/libosmocore/+/24881 )


Change subject: fix api doc of osmo_identifier_sanitize_buf()
......................................................................

fix api doc of osmo_identifier_sanitize_buf()

The implementation cleary replaces sep_chars instead of keeping them.
Adjust the doc to clarify that.

It seems to me that the intention was to *allow* sep_chars instead of
replacing them, especially when looking at sep_chars of
osmo_separated_identifiers_valid(). But we're stuck with that now.

Change-Id: Ia842a7eeb46b49ee364be55c1194e463ebcaf392
---
M src/utils.c
1 file changed, 1 insertion(+), 1 deletion(-)



  git pull ssh://gerrit.osmocom.org:29418/libosmocore refs/changes/81/24881/1

diff --git a/src/utils.c b/src/utils.c
index f5896c4..721c34a 100644
--- a/src/utils.c
+++ b/src/utils.c
@@ -687,7 +687,7 @@
  * To guarantee passing osmo_separated_identifiers_valid(), replace_with must not itself be an illegal character. If in
  * doubt, use '-'.
  * \param[inout] str  Identifier to sanitize, must be nul terminated and in a writable buffer.
- * \param[in] sep_chars  Additional characters that are allowed besides osmo_identifier_illegal_chars.
+ * \param[in] sep_chars  Additional characters that are to be replaced besides osmo_identifier_illegal_chars.
  * \param[in] replace_with  Replace any illegal characters with this character.
  */
 void osmo_identifier_sanitize_buf(char *str, const char *sep_chars, char replace_with)

-- 
To view, visit https://gerrit.osmocom.org/c/libosmocore/+/24881
To unsubscribe, or for help writing mail filters, visit https://gerrit.osmocom.org/settings

Gerrit-Project: libosmocore
Gerrit-Branch: master
Gerrit-Change-Id: Ia842a7eeb46b49ee364be55c1194e463ebcaf392
Gerrit-Change-Number: 24881
Gerrit-PatchSet: 1
Gerrit-Owner: neels <nhofmeyr at sysmocom.de>
Gerrit-MessageType: newchange
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osmocom.org/pipermail/gerrit-log/attachments/20210707/55c92045/attachment.htm>


More information about the gerrit-log mailing list