Deprecations

While the deprecations here are denoted in C++ they also include bindings versions of the API.

Currently deprecated methods:

Warning

doxygenpage: Cannot find page “deprecated” in doxygen xml output for project “dnf5” from directory: /home/docs/checkouts/readthedocs.org/user_builds/dnf5/checkouts/latest/doc/xml/

📢 Deprecation signaling

  • build-time warnings using [[deprecated]] attribute, see: cppreference

  • run-time warnings on stderr via LIBDNF5_DEPRECATED(msg)

  • deprecated API is marked in documentation using the @@deprecated tag

  • deprecations should be publicly announced on mailing list and GitHub

  • deprecations should include guidance on what to use instead

Example:

foo.hpp
/// @@deprecated Use baz()
[[deprecated("Use baz()")]]
void foo();
foo.cpp
#include "utils/deprecate.hpp"

void foo() {
    LIBDNF5_DEPRECATED("Use baz()");
    ...
}