From c0f00499b147c33a7b23c81526b581524ce154b9 Mon Sep 17 00:00:00 2001 From: Markus Date: Wed, 30 Nov 2016 15:11:16 +0100 Subject: [PATCH] Clarify documentation (#1368) clarify documentation of private torrents --- include/libtorrent/create_torrent.hpp | 10 +++++----- include/libtorrent/torrent_info.hpp | 4 ++-- 2 files changed, 7 insertions(+), 7 deletions(-) diff --git a/include/libtorrent/create_torrent.hpp b/include/libtorrent/create_torrent.hpp index 15a523d94..eb919ff0b 100644 --- a/include/libtorrent/create_torrent.hpp +++ b/include/libtorrent/create_torrent.hpp @@ -256,9 +256,9 @@ namespace libtorrent void set_root_cert(string_view pem); // Sets and queries the private flag of the torrent. - // Torrents with the private flag set ask clients to not use any other - // sources than the tracker for peers, and to not advertise itself publicly, - // apart from the tracker. + // Torrents with the private flag set ask the client to not use any other + // sources than the tracker for peers, and to not use DHT to advertise itself publicly, + // only the tracker. void set_priv(bool p) { m_private = p; } bool priv() const { return m_private; } @@ -347,8 +347,8 @@ namespace libtorrent // and they have the same name. bool m_multifile:1; - // this is true if the torrent is private. i.e., is should not - // be announced on the dht + // this is true if the torrent is private. i.e., the client should not + // advertise itself on the DHT for this torrent bool m_private:1; // if set to one, a merkle torrent will be generated diff --git a/include/libtorrent/torrent_info.hpp b/include/libtorrent/torrent_info.hpp index 5287f812d..a755b15eb 100644 --- a/include/libtorrent/torrent_info.hpp +++ b/include/libtorrent/torrent_info.hpp @@ -397,8 +397,8 @@ namespace libtorrent // metadata resolved yet or not. bool is_valid() const { return m_files.is_valid(); } - // returns true if this torrent is private. i.e., it should not be - // distributed on the trackerless network (the kademlia DHT). + // returns true if this torrent is private. i.e., the client should not + // advertise itself on the trackerless network (the Kademlia DHT) for this torrent. bool priv() const { return (m_flags & private_torrent) != 0; } // returns true if this is an i2p torrent. This is determined by whether