sys/ubjson: deprecate module.

Summary for Users
=================

 Deprecation is scheduled for 2020.01.
 Users which depend on this module and cannot switch libraries may copy
 the code into to their own application.

As expressed in PR #11724, the UBJSON module has issues which are not easy
or worth fixing.

Before removing the module, it should be marked as deprecated to give users
time to either migrate to another library, or copy the code to their own
private repo.

The deprecation warning has been supressed from the unit tests. This has the
ugly side-effect of supressing deprecation warning in other unit tests too,
but that should not last long, only until the module is finally deleted.
This commit is contained in:
Juan Carrano 2019-06-25 14:49:36 +02:00
parent 90e8da0a9b
commit 3b8deac3e9
2 changed files with 5 additions and 2 deletions

View File

@ -187,14 +187,15 @@ typedef enum {
UBJSON_SIZE_ERROR, /**< the length of a field exceeded SSIZE_MAX */
} ubjson_read_callback_result_t;
struct ubjson_cookie;
struct __attribute__ ((deprecated("The UBJSON module will be removed in release 2020.01"))) ubjson_cookie;
/**
* @brief A cookie passed between the read and write functions.
* @details You probably want to wrap the cookie in some other data structure,
* which you retrieve with container_of() in the callback.
*/
typedef struct ubjson_cookie ubjson_cookie_t;
typedef struct ubjson_cookie ubjson_cookie_t
__attribute__ ((deprecated("The UBJSON module will be removed in release 2020.01")));
/**
* @brief Method called by ubjson_read() to get more data.

View File

@ -1,2 +1,4 @@
USEMODULE += ubjson
USEMODULE += pipe
CFLAGS += -Wno-error=deprecated-declarations