config doc gen: generate formatted code

node/config/cfgdocgen/gen.go

@@ -110,7 +110,7 @@ var Doc = map[string][]DocField{
 		for _, f := range typ {
 			fmt.Println("\t\t{")
 			fmt.Printf("\t\t\tName: \"%s\",\n", f.Name)
-			fmt.Printf("\t\t\tType:    \"%s\",\n", f.Type)
+			fmt.Printf("\t\t\tType: \"%s\",\n\n", f.Type)
 			fmt.Printf("\t\t\tComment: `%s`,\n", f.Comment)
 			fmt.Println("\t\t},")
 		}

node/config/doc_gen.go

@@ -13,16 +13,19 @@ var Doc = map[string][]DocField{
 		{
 			Name: "ListenAddress",
 			Type: "string",
+
 			Comment: `Binding address for the Lotus API`,
 		},
 		{
 			Name: "RemoteListenAddress",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "Timeout",
 			Type: "Duration",
+
 			Comment: ``,
 		},
 	},
@@ -30,6 +33,7 @@ var Doc = map[string][]DocField{
 		{
 			Name: "DisableMetadataLog",
 			Type: "bool",
+
 			Comment: ``,
 		},
 	},
@@ -37,11 +41,13 @@ var Doc = map[string][]DocField{
 		{
 			Name: "Base",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 		{
 			Name: "PerSector",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 	},
@@ -49,11 +55,13 @@ var Doc = map[string][]DocField{
 		{
 			Name: "EnableSplitstore",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "Splitstore",
 			Type: "Splitstore",
+
 			Comment: ``,
 		},
 	},
@@ -61,26 +69,31 @@ var Doc = map[string][]DocField{
 		{
 			Name: "UseIpfs",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "IpfsOnlineMode",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "IpfsMAddr",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "IpfsUseForRetrieval",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "SimultaneousTransfers",
 			Type: "uint64",
+
 			Comment: ``,
 		},
 	},
@@ -88,21 +101,25 @@ var Doc = map[string][]DocField{
 		{
 			Name: "API",
 			Type: "API",
+
 			Comment: ``,
 		},
 		{
 			Name: "Backup",
 			Type: "Backup",
+
 			Comment: ``,
 		},
 		{
 			Name: "Libp2p",
 			Type: "Libp2p",
+
 			Comment: ``,
 		},
 		{
 			Name: "Pubsub",
 			Type: "Pubsub",
+
 			Comment: ``,
 		},
 	},
@@ -110,84 +127,100 @@ var Doc = map[string][]DocField{
 		{
 			Name: "ConsiderOnlineStorageDeals",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConsiderOfflineStorageDeals",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConsiderOnlineRetrievalDeals",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConsiderOfflineRetrievalDeals",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConsiderVerifiedStorageDeals",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConsiderUnverifiedStorageDeals",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "PieceCidBlocklist",
 			Type: "[]cid.Cid",
+
 			Comment: ``,
 		},
 		{
 			Name: "ExpectedSealDuration",
 			Type: "Duration",
+
 			Comment: ``,
 		},
 		{
 			Name: "MaxDealStartDelay",
 			Type: "Duration",
+
 			Comment: `Maximum amount of time proposed deal StartEpoch can be in future`,
 		},
 		{
 			Name: "PublishMsgPeriod",
 			Type: "Duration",
+
 			Comment: `The amount of time to wait for more deals to arrive before
 publishing`,
 		},
 		{
 			Name: "MaxDealsPerPublishMsg",
 			Type: "uint64",
+
 			Comment: `The maximum number of deals to include in a single PublishStorageDeals
 message`,
 		},
 		{
 			Name: "MaxProviderCollateralMultiplier",
 			Type: "uint64",
+
 			Comment: `The maximum collateral that the provider will put up against a deal,
 as a multiplier of the minimum collateral bound`,
 		},
 		{
 			Name: "SimultaneousTransfers",
 			Type: "uint64",
+
 			Comment: `The maximum number of parallel online data transfers (storage+retrieval)`,
 		},
 		{
 			Name: "Filter",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "RetrievalFilter",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "RetrievalPricing",
 			Type: "*RetrievalPricing",
+
 			Comment: ``,
 		},
 	},
@@ -195,6 +228,7 @@ as a multiplier of the minimum collateral bound`,
 		{
 			Name: "DefaultMaxFee",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 	},
@@ -202,26 +236,31 @@ as a multiplier of the minimum collateral bound`,
 		{
 			Name: "Client",
 			Type: "Client",
+
 			Comment: ``,
 		},
 		{
 			Name: "Metrics",
 			Type: "Metrics",
+
 			Comment: ``,
 		},
 		{
 			Name: "Wallet",
 			Type: "Wallet",
+
 			Comment: ``,
 		},
 		{
 			Name: "Fees",
 			Type: "FeeConfig",
+
 			Comment: ``,
 		},
 		{
 			Name: "Chainstore",
 			Type: "Chainstore",
+
 			Comment: ``,
 		},
 	},
@@ -229,41 +268,49 @@ as a multiplier of the minimum collateral bound`,
 		{
 			Name: "ListenAddresses",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "AnnounceAddresses",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "NoAnnounceAddresses",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "BootstrapPeers",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "ProtectedPeers",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConnMgrLow",
 			Type: "uint",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConnMgrHigh",
 			Type: "uint",
+
 			Comment: ``,
 		},
 		{
 			Name: "ConnMgrGrace",
 			Type: "Duration",
+
 			Comment: ``,
 		},
 	},
@@ -271,11 +318,13 @@ as a multiplier of the minimum collateral bound`,
 		{
 			Name: "Nickname",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "HeadNotifs",
 			Type: "bool",
+
 			Comment: ``,
 		},
 	},
@@ -283,32 +332,38 @@ as a multiplier of the minimum collateral bound`,
 		{
 			Name: "PreCommitControl",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "CommitControl",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "TerminateControl",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "DealPublishControl",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "DisableOwnerFallback",
 			Type: "bool",
+
 			Comment: `DisableOwnerFallback disables usage of the owner address for messages
 sent automatically`,
 		},
 		{
 			Name: "DisableWorkerFallback",
 			Type: "bool",
+
 			Comment: `DisableWorkerFallback disables usage of the worker address for messages
 sent automatically, if control addresses are configured.
 A control address that doesn't have enough funds will still be chosen
@@ -319,41 +374,49 @@ over the worker address if this flag is set.`,
 		{
 			Name: "MaxPreCommitGasFee",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 		{
 			Name: "MaxCommitGasFee",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 		{
 			Name: "MaxPreCommitBatchGasFee",
 			Type: "BatchFeeConfig",
+
 			Comment: `maxBatchFee = maxBase + maxPerSector * nSectors`,
 		},
 		{
 			Name: "MaxCommitBatchGasFee",
 			Type: "BatchFeeConfig",
+
 			Comment: ``,
 		},
 		{
 			Name: "MaxTerminateGasFee",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 		{
 			Name: "MaxWindowPoStGasFee",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 		{
 			Name: "MaxPublishDealsFee",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 		{
 			Name: "MaxMarketBalanceAddFee",
 			Type: "types.FIL",
+
 			Comment: ``,
 		},
 	},
@@ -361,31 +424,37 @@ over the worker address if this flag is set.`,
 		{
 			Name: "EnableMining",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "EnableSealing",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "EnableSectorStorage",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "EnableMarkets",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "SealerApiInfo",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "SectorIndexApiInfo",
 			Type: "string",
+
 			Comment: ``,
 		},
 	},
@@ -393,21 +462,25 @@ over the worker address if this flag is set.`,
 		{
 			Name: "Bootstrapper",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "DirectPeers",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "IPColocationWhitelist",
 			Type: "[]string",
+
 			Comment: ``,
 		},
 		{
 			Name: "RemoteTracer",
 			Type: "string",
+
 			Comment: ``,
 		},
 	},
@@ -415,16 +488,19 @@ over the worker address if this flag is set.`,
 		{
 			Name: "Strategy",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "Default",
 			Type: "*RetrievalPricingDefault",
+
 			Comment: ``,
 		},
 		{
 			Name: "External",
 			Type: "*RetrievalPricingExternal",
+
 			Comment: ``,
 		},
 	},
@@ -432,6 +508,7 @@ over the worker address if this flag is set.`,
 		{
 			Name: "VerifiedDealsFreeTransfer",
 			Type: "bool",
+
 			Comment: `VerifiedDealsFreeTransfer configures zero fees for data transfer for a retrieval deal
 of a payloadCid that belongs to a verified storage deal.
 This parameter is ONLY applicable if the retrieval pricing policy strategy has been configured to "default".
@@ -442,6 +519,7 @@ default value is true`,
 		{
 			Name: "Path",
 			Type: "string",
+
 			Comment: `Path of the external script that will be run to price a retrieval deal.
 This parameter is ONLY applicable if the retrieval pricing policy strategy has been configured to "external".`,
 		},
@@ -450,112 +528,134 @@ This parameter is ONLY applicable if the retrieval pricing policy strategy has b
 		{
 			Name: "MaxWaitDealsSectors",
 			Type: "uint64",
+
 			Comment: `0 = no limit`,
 		},
 		{
 			Name: "MaxSealingSectors",
 			Type: "uint64",
+
 			Comment: `includes failed, 0 = no limit`,
 		},
 		{
 			Name: "MaxSealingSectorsForDeals",
 			Type: "uint64",
+
 			Comment: `includes failed, 0 = no limit`,
 		},
 		{
 			Name: "WaitDealsDelay",
 			Type: "Duration",
+
 			Comment: ``,
 		},
 		{
 			Name: "AlwaysKeepUnsealedCopy",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "FinalizeEarly",
 			Type: "bool",
+
 			Comment: `Run sector finalization before submitting sector proof to the chain`,
 		},
 		{
 			Name: "CollateralFromMinerBalance",
 			Type: "bool",
+
 			Comment: `Whether to use available miner balance for sector collateral instead of sending it with each message`,
 		},
 		{
 			Name: "AvailableBalanceBuffer",
 			Type: "types.FIL",
+
 			Comment: `Minimum available balance to keep in the miner actor before sending it with messages`,
 		},
 		{
 			Name: "DisableCollateralFallback",
 			Type: "bool",
+
 			Comment: `Don't send collateral with messages even if there is no available balance in the miner actor`,
 		},
 		{
 			Name: "BatchPreCommits",
 			Type: "bool",
+
 			Comment: `enable / disable precommit batching (takes effect after nv13)`,
 		},
 		{
 			Name: "MaxPreCommitBatch",
 			Type: "int",
+
 			Comment: `maximum precommit batch size - batches will be sent immediately above this size`,
 		},
 		{
 			Name: "PreCommitBatchWait",
 			Type: "Duration",
+
 			Comment: `how long to wait before submitting a batch after crossing the minimum batch size`,
 		},
 		{
 			Name: "PreCommitBatchSlack",
 			Type: "Duration",
+
 			Comment: `time buffer for forceful batch submission before sectors/deal in batch would start expiring`,
 		},
 		{
 			Name: "AggregateCommits",
 			Type: "bool",
+
 			Comment: `enable / disable commit aggregation (takes effect after nv13)`,
 		},
 		{
 			Name: "MinCommitBatch",
 			Type: "int",
+
 			Comment: `maximum batched commit size - batches will be sent immediately above this size`,
 		},
 		{
 			Name: "MaxCommitBatch",
 			Type: "int",
+
 			Comment: ``,
 		},
 		{
 			Name: "CommitBatchWait",
 			Type: "Duration",
+
 			Comment: `how long to wait before submitting a batch after crossing the minimum batch size`,
 		},
 		{
 			Name: "CommitBatchSlack",
 			Type: "Duration",
+
 			Comment: `time buffer for forceful batch submission before sectors/deals in batch would start expiring`,
 		},
 		{
 			Name: "AggregateAboveBaseFee",
 			Type: "types.FIL",
+
 			Comment: `network BaseFee below which to stop doing commit aggregation, instead
 submitting proofs to the chain individually`,
 		},
 		{
 			Name: "TerminateBatchMax",
 			Type: "uint64",
+
 			Comment: ``,
 		},
 		{
 			Name: "TerminateBatchMin",
 			Type: "uint64",
+
 			Comment: ``,
 		},
 		{
 			Name: "TerminateBatchWait",
 			Type: "Duration",
+
 			Comment: ``,
 		},
 	},
@@ -563,21 +663,25 @@ submitting proofs to the chain individually`,
 		{
 			Name: "ColdStoreType",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "HotStoreType",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "MarkSetType",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "HotStoreMessageRetention",
 			Type: "uint64",
+
 			Comment: ``,
 		},
 	},
@@ -585,31 +689,37 @@ submitting proofs to the chain individually`,
 		{
 			Name: "Subsystems",
 			Type: "MinerSubsystemConfig",
+
 			Comment: ``,
 		},
 		{
 			Name: "Dealmaking",
 			Type: "DealmakingConfig",
+
 			Comment: ``,
 		},
 		{
 			Name: "Sealing",
 			Type: "SealingConfig",
+
 			Comment: ``,
 		},
 		{
 			Name: "Storage",
 			Type: "sectorstorage.SealerConfig",
+
 			Comment: ``,
 		},
 		{
 			Name: "Fees",
 			Type: "MinerFeeConfig",
+
 			Comment: ``,
 		},
 		{
 			Name: "Addresses",
 			Type: "MinerAddressConfig",
+
 			Comment: ``,
 		},
 	},
@@ -617,16 +727,19 @@ submitting proofs to the chain individually`,
 		{
 			Name: "RemoteBackend",
 			Type: "string",
+
 			Comment: ``,
 		},
 		{
 			Name: "EnableLedger",
 			Type: "bool",
+
 			Comment: ``,
 		},
 		{
 			Name: "DisableLocal",
 			Type: "bool",
+
 			Comment: ``,
 		},
 	},