config: Port some docstrings from go-ipfs

filecoin-project · Aug 27, 2021 · 3708a7a · 3708a7a
1 parent 17b7dce
commit 3708a7a
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 5 deletions.
diff --git a/node/config/doc_gen.go b/node/config/doc_gen.go
diff --git a/node/config/types.go b/node/config/types.go
@@ -298,8 +298,15 @@ type Libp2p struct {
 	// it makes the local lotus node accessible from the public internet
 	DisableNatPortMap bool
 
-	ConnMgrLow   uint
-	ConnMgrHigh  uint
+	// ConnMgrLow is the number of connections that the basic connection manager
+	// will trim down to.
+	ConnMgrLow uint
+	// ConnMgrHigh is the number of connections that, when exceeded, will trigger
+	// a connection GC operation. Note: protected/recently formed connections don't
+	// count towards this limit.
+	ConnMgrHigh uint
+	// ConnMgrGrace is a time duration that new connections are immune from being
+	// closed by the connection manager.
 	ConnMgrGrace Duration
 }