From 5c33fe25c55dcb03e9ccac9fad46286863f9319e Mon Sep 17 00:00:00 2001 From: arvidn Date: Sat, 11 Apr 2020 09:56:09 +0200 Subject: [PATCH] improve documentation for native_handle --- include/libtorrent/torrent_handle.hpp | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/include/libtorrent/torrent_handle.hpp b/include/libtorrent/torrent_handle.hpp index b3070023a..5ce8cebc9 100644 --- a/include/libtorrent/torrent_handle.hpp +++ b/include/libtorrent/torrent_handle.hpp @@ -1247,10 +1247,16 @@ namespace aux { } // This function is intended only for use by plugins and the alert - // dispatch function. This type does not have a stable API and should + // dispatch function. This type does not have a stable ABI and should // be relied on as little as possible. Accessing the handle returned by // this function is not thread safe outside of libtorrent's internal // thread (which is used to invoke plugin callbacks). + // The ``torrent`` class is not only eligible for changing ABI across + // minor versions of libtorrent, its layout is also dependent on build + // configuration. This adds additional requirements on a client to be + // built with the exact same build configuration as libtorrent itself. + // i.e. the ``TORRENT_`` macros must match between libtorrent and the + // client builds. std::shared_ptr native_handle() const; private: