libnm/docs: document nm_utils_is_uuid() as deprecated

However, don't also use the NM_DEPRECATED_IN_1_32 macro, because that
causes annoying compiler warnings.

There is no replacement for the function in libnm, nor is it planned
to add one. So users may still call it, but they are now warned by
documentation that it may not be a good idea.
This commit is contained in:
Thomas Haller 2021-05-27 09:29:21 +02:00
parent 840dd8cbcd
commit cbaeadb0a4
No known key found for this signature in database
GPG key ID: 29C2366E4DFC5728

View file

@ -4429,6 +4429,10 @@ nm_utils_iface_valid_name(const char *name)
*
* In older versions, nm_utils_is_uuid() did not accept %NULL as @str
* argument. Don't pass %NULL if you run against older versions of libnm.
*
* Deprecated: 1.32: older versions of NetworkManager had a wrong
* understanding of what makes a valid UUID. This function can thus
* accept some inputs as valid, which in fact are not valid UUIDs.
*/
gboolean
nm_utils_is_uuid(const char *str)