From db3b915a171c67c32d2136ec155877e5b63e9035 Mon Sep 17 00:00:00 2001 From: Lars Gierth Date: Wed, 28 Mar 2018 03:44:49 +0200 Subject: [PATCH] docs: remove mentions of coral, it's not implemented --- dht.go | 4 ++-- dht_bootstrap.go | 2 +- pb/dht.pb.go | 1 + pb/dht.proto | 1 + routing.go | 5 +++-- 5 files changed, 8 insertions(+), 5 deletions(-) diff --git a/dht.go b/dht.go index 869a68eea..305c46c6a 100644 --- a/dht.go +++ b/dht.go @@ -1,5 +1,5 @@ // Package dht implements a distributed hash table that satisfies the ipfs routing -// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications. +// interface. This DHT is modeled after kademlia with S/Kademlia modifications. package dht import ( @@ -40,7 +40,7 @@ var ProtocolDHTOld protocol.ID = "/ipfs/dht" // collect members of the routing table. const NumBootstrapQueries = 5 -// IpfsDHT is an implementation of Kademlia with Coral and S/Kademlia modifications. +// IpfsDHT is an implementation of Kademlia with S/Kademlia modifications. // It is used to implement the base IpfsRouting module. type IpfsDHT struct { host host.Host // the network services we need diff --git a/dht_bootstrap.go b/dht_bootstrap.go index fa74d3851..ea71bfdee 100644 --- a/dht_bootstrap.go +++ b/dht_bootstrap.go @@ -1,5 +1,5 @@ // Package dht implements a distributed hash table that satisfies the ipfs routing -// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications. +// interface. This DHT is modeled after Kademlia with S/Kademlia modifications. package dht import ( diff --git a/pb/dht.pb.go b/pb/dht.pb.go index f5e3fb71e..43d22b406 100644 --- a/pb/dht.pb.go +++ b/pb/dht.pb.go @@ -116,6 +116,7 @@ type Message struct { // defines what type of message it is. Type *Message_MessageType `protobuf:"varint,1,opt,name=type,enum=dht.pb.Message_MessageType" json:"type,omitempty"` // defines what coral cluster level this query/response belongs to. + // in case we want to implement coral's cluster rings in the future. ClusterLevelRaw *int32 `protobuf:"varint,10,opt,name=clusterLevelRaw" json:"clusterLevelRaw,omitempty"` // Used to specify the key associated with this message. // PUT_VALUE, GET_VALUE, ADD_PROVIDER, GET_PROVIDERS diff --git a/pb/dht.proto b/pb/dht.proto index 66fad9803..a6d1ba412 100644 --- a/pb/dht.proto +++ b/pb/dht.proto @@ -50,6 +50,7 @@ message Message { optional MessageType type = 1; // defines what coral cluster level this query/response belongs to. + // in case we want to implement coral's cluster rings in the future. optional int32 clusterLevelRaw = 10; // Used to specify the key associated with this message. diff --git a/routing.go b/routing.go index 25c0bd5c3..5d6bdaca3 100644 --- a/routing.go +++ b/routing.go @@ -246,8 +246,9 @@ func (dht *IpfsDHT) GetValues(ctx context.Context, key string, nvals int) (_ []r return vals, nil } -// Value provider layer of indirection. -// This is what DSHTs (Coral and MainlineDHT) do to store large values in a DHT. +// Provider abstraction for indirect stores. +// Some DHTs store values directly, while an indirect store stores pointers to +// locations of the value, similarly to Coral and Mainline DHT. // Provide makes this node announce that it can provide a value for the given key func (dht *IpfsDHT) Provide(ctx context.Context, key *cid.Cid, brdcst bool) (err error) {