Merge pull request #10968 from filecoin-project/sbansal/msgindex-comment

Add comment stating msgIndex is an experimental feature
2023-06-09 12:53:40 -05:00 · 2023-06-09 12:53:40 -05:00 · 5b31b79d58
commit 5b31b79d58
parent 28951e5919 fc719e710f
3 changed files with 4 additions and 1 deletions
--- a/documentation/en/default-lotus-config.toml
+++ b/documentation/en/default-lotus-config.toml
@ -391,6 +391,7 @@


 [Index]
+  # EXPERIMENTAL FEATURE. USE WITH CAUTION
  # EnableMsgIndex enables indexing of messages on chain.
  #
  # type: bool
--- a/node/config/doc_gen.go
+++ b/node/config/doc_gen.go
@ -473,7 +473,8 @@ Set to 0 to keep all mappings`,
 			Name: "EnableMsgIndex",
 			Type: "bool",

-			Comment: `EnableMsgIndex enables indexing of messages on chain.`,
+			Comment: `EXPERIMENTAL FEATURE. USE WITH CAUTION
+EnableMsgIndex enables indexing of messages on chain.`,
 		},
 	},
 	"IndexProviderConfig": []DocField{
--- a/node/config/types.go
+++ b/node/config/types.go
@ -728,6 +728,7 @@ type Events struct {
 }

 type IndexConfig struct {
+	// EXPERIMENTAL FEATURE. USE WITH CAUTION
 	// EnableMsgIndex enables indexing of messages on chain.
 	EnableMsgIndex bool
 }