Skip to content

Commit db3b915

Browse files
author
Lars Gierth
committed
docs: remove mentions of coral, it's not implemented
1 parent 25416c3 commit db3b915

File tree

5 files changed

+8
-5
lines changed

5 files changed

+8
-5
lines changed

dht.go

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Package dht implements a distributed hash table that satisfies the ipfs routing
2-
// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications.
2+
// interface. This DHT is modeled after kademlia with S/Kademlia modifications.
33
package dht
44

55
import (
@@ -40,7 +40,7 @@ var ProtocolDHTOld protocol.ID = "/ipfs/dht"
4040
// collect members of the routing table.
4141
const NumBootstrapQueries = 5
4242

43-
// IpfsDHT is an implementation of Kademlia with Coral and S/Kademlia modifications.
43+
// IpfsDHT is an implementation of Kademlia with S/Kademlia modifications.
4444
// It is used to implement the base IpfsRouting module.
4545
type IpfsDHT struct {
4646
host host.Host // the network services we need

dht_bootstrap.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
// Package dht implements a distributed hash table that satisfies the ipfs routing
2-
// interface. This DHT is modeled after kademlia with Coral and S/Kademlia modifications.
2+
// interface. This DHT is modeled after Kademlia with S/Kademlia modifications.
33
package dht
44

55
import (

pb/dht.pb.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pb/dht.proto

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ message Message {
5050
optional MessageType type = 1;
5151

5252
// defines what coral cluster level this query/response belongs to.
53+
// in case we want to implement coral's cluster rings in the future.
5354
optional int32 clusterLevelRaw = 10;
5455

5556
// Used to specify the key associated with this message.

routing.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -246,8 +246,9 @@ func (dht *IpfsDHT) GetValues(ctx context.Context, key string, nvals int) (_ []r
246246
return vals, nil
247247
}
248248

249-
// Value provider layer of indirection.
250-
// This is what DSHTs (Coral and MainlineDHT) do to store large values in a DHT.
249+
// Provider abstraction for indirect stores.
250+
// Some DHTs store values directly, while an indirect store stores pointers to
251+
// locations of the value, similarly to Coral and Mainline DHT.
251252

252253
// Provide makes this node announce that it can provide a value for the given key
253254
func (dht *IpfsDHT) Provide(ctx context.Context, key *cid.Cid, brdcst bool) (err error) {

0 commit comments

Comments
 (0)