[riot-commits] [RIOT-OS/RIOT] 3b8dea: sys/ubjson: deprecate module.

Leandro Lanzieri noreply at github.com
Fri Jun 28 19:41:24 CEST 2019


  Branch: refs/heads/master
  Home:   https://github.com/RIOT-OS/RIOT
  Commit: 3b8deac3e93f139711c02b93dfd49d17e823b025
      https://github.com/RIOT-OS/RIOT/commit/3b8deac3e93f139711c02b93dfd49d17e823b025
  Author: Juan Carrano <j.carrano at fu-berlin.de>
  Date:   2019-06-28 (Fri, 28 Jun 2019)

  Changed paths:
    M sys/include/ubjson.h
    M tests/unittests/tests-ubjson/Makefile.include

  Log Message:
  -----------
  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.


  Commit: 2d782bc225003a56d1894311afacf4c0c3d65d49
      https://github.com/RIOT-OS/RIOT/commit/2d782bc225003a56d1894311afacf4c0c3d65d49
  Author: Juan Carrano <j.carrano at fu-berlin.de>
  Date:   2019-06-28 (Fri, 28 Jun 2019)

  Changed paths:
    M sys/include/ubjson.h

  Log Message:
  -----------
  sys/ubjson: add deprecation notices to the documentation.

Add @deprecated doxygen tags to the module, the header and the main
reader and writer functions.


  Commit: 326ec30074c6b09b6d08c53c0deb3221f2a82dbf
      https://github.com/RIOT-OS/RIOT/commit/326ec30074c6b09b6d08c53c0deb3221f2a82dbf
  Author: Leandro Lanzieri <leandro.lanzieri at haw-hamburg.de>
  Date:   2019-06-28 (Fri, 28 Jun 2019)

  Changed paths:
    M sys/include/ubjson.h
    M tests/unittests/tests-ubjson/Makefile.include

  Log Message:
  -----------
  Merge pull request #11741 from jcarrano/deprecate-ubjson

sys/ubjson: deprecate module.


Compare: https://github.com/RIOT-OS/RIOT/compare/8cd5fc20af8b...326ec30074c6


More information about the commits mailing list