From 3708a7ac30fb36d4fe7c9eaa1dff854179cef347 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=C5=81ukasz=20Magiera?= Date: Fri, 27 Aug 2021 19:16:50 +0200 Subject: [PATCH] config: Port some docstrings from go-ipfs --- node/config/doc_gen.go | 10 +++++++--- node/config/types.go | 11 +++++++++-- 2 files changed, 16 insertions(+), 5 deletions(-) diff --git a/node/config/doc_gen.go b/node/config/doc_gen.go index 2228393e45c..dd6dda50df5 100644 --- a/node/config/doc_gen.go +++ b/node/config/doc_gen.go @@ -361,19 +361,23 @@ it makes the local lotus node accessible from the public internet`, Name: "ConnMgrLow", Type: "uint", - Comment: ``, + Comment: `ConnMgrLow is the number of connections that the basic connection manager +will trim down to.`, }, { Name: "ConnMgrHigh", Type: "uint", - Comment: ``, + Comment: `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.`, }, { Name: "ConnMgrGrace", Type: "Duration", - Comment: ``, + Comment: `ConnMgrGrace is a time duration that new connections are immune from being +closed by the connection manager.`, }, }, "MinerAddressConfig": []DocField{ diff --git a/node/config/types.go b/node/config/types.go index 499912d4043..97b0812d7c8 100644 --- 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 }