docs: remove mentions of coral, it's not implemented

libp2p · Mar 28, 2018 · db3b915 · db3b915
1 parent 25416c3
commit db3b915
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 5 deletions.
diff --git 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
@@ -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
diff --git 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
@@ -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) {