Fix config doc

filecoin-project · May 23, 2022 · 70f3b98 · 70f3b98
1 parent 8c081e2
commit 70f3b98
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 3 deletions.
diff --git a/documentation/en/default-lotus-miner-config.toml b/documentation/en/default-lotus-miner-config.toml
@@ -542,6 +542,15 @@
   # env var: LOTUS_STORAGE_ASSIGNER
   #Assigner = "utilization"
 
+  # DisallowRemoteFinalize when set to true will force all Finalize tasks to
+  # run on workers with local access to both long-term storage and the sealing
+  # path containing the sector.
+  # --
+  # WARNING: Only set this if all workers have access to long-term storage
+  # paths. If this flag is enabled, and there are workers without long-term
+  # storage access, sectors will not be moved from them, and Finalize tasks
+  # will appear to be stuck.
+  # --
   # If you see stuck Finalize tasks after enabling this setting, check
   # 'lotus-miner sealing sched-diag' and 'lotus-miner storage find [sector num]'
   #

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
@@ -338,12 +338,12 @@ type SealerConfig struct {
 	// DisallowRemoteFinalize when set to true will force all Finalize tasks to
 	// run on workers with local access to both long-term storage and the sealing
 	// path containing the sector.
-	//
+	// --
 	// WARNING: Only set this if all workers have access to long-term storage
 	// paths. If this flag is enabled, and there are workers without long-term
 	// storage access, sectors will not be moved from them, and Finalize tasks
 	// will appear to be stuck.
-	//
+	// --
 	// If you see stuck Finalize tasks after enabling this setting, check
 	// 'lotus-miner sealing sched-diag' and 'lotus-miner storage find [sector num]'
 	DisallowRemoteFinalize bool