docs: point to SetDefaultServiceLimits in ResourceManager option (#1636)

libp2p · Jul 3, 2022 · 19090e5 · 19090e5
1 parent 0d7f192
commit 19090e5
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/options.go b/options.go
@@ -342,6 +342,8 @@ func ConnectionGater(cg connmgr.ConnectionGater) Option {
 }
 
 // ResourceManager configures libp2p to use the given ResourceManager.
+// When using the go-libp2p-resource-manager implementation of the ResourceManager interface,
+// it is recommended to set limits for libp2p protocol by calling SetDefaultServiceLimits.
 func ResourceManager(rcmgr network.ResourceManager) Option {
 	return func(cfg *Config) error {
 		if cfg.ResourceManager != nil {