From a7971219533eee82271a221b8c2341b35f4c3bf5 Mon Sep 17 00:00:00 2001 From: Aryan Rahar Date: Sat, 23 Aug 2025 20:28:31 +0000 Subject: [PATCH] docs(cpp): clarify ownership of Conf::dump() return (#5166) Document that Conf::dump() returns a heap-allocated std::list owned by the caller. Also add a CHANGELOG entry. --- CHANGELOG.md | 7 +++++++ src-cpp/rdkafkacpp.h | 13 +++++++++++-- 2 files changed, 18 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 92bb44684..996c38189 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,10 @@ +# librdkafka v2.11.2 (unreleased) + +## Fixes + +* C++ docs: Clarify ownership of `RdKafka::Conf::dump()` return value (#5166, @aryanrahar) + + # librdkafka v2.11.1 librdkafka v2.11.1 is a maintenance release: diff --git a/src-cpp/rdkafkacpp.h b/src-cpp/rdkafkacpp.h index 8d8aebabe..af477a1c2 100644 --- a/src-cpp/rdkafkacpp.h +++ b/src-cpp/rdkafkacpp.h @@ -1436,8 +1436,17 @@ class RD_EXPORT Conf { virtual Conf::ConfResult get( SslCertificateVerifyCb *&ssl_cert_verify_cb) const = 0; - /** @brief Dump configuration names and values to list containing - * name,value tuples */ + /** @brief Dump configuration names and values to a list containing + * name,value tuples. + * + * @remark Ownership: The returned std::list is heap-allocated. + * The caller owns the list and must delete it when done, e.g.: + * @code + * std::list *lst = conf->dump(); + * // ... use lst ... + * delete lst; + * @endcode + */ virtual std::list *dump() = 0; /** @brief Use with \p name = \c \"consume_cb\" */