1
0
mirror of https://github.com/RIOT-OS/RIOT.git synced 2024-12-29 04:50:03 +01:00

Merge pull request #10605 from chrysn-pull-requests/warn_saul_reg_rm

Deprecate saul_reg_rm
This commit is contained in:
chrysn 2020-05-26 11:39:48 +02:00 committed by GitHub
commit 51b95b775c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -72,6 +72,16 @@ int saul_reg_add(saul_reg_t *dev);
/**
* @brief Unregister a device from the SAUL registry
*
* @warning Removing the device at runtime can send applications that have
* looked up that device into invalid states, and should thus be
* avoided.
*
* @warning This function must only be used by drivers that advise developers
* using them on how to prevent race conditions when using SAUL.
*
* @deprecated This function will be removed soon as it is practically unusable
* for the above reasons.
*
* @param[in] dev pointer to a registry entry
*
* @return 0 on success