docs: note raw-leaves impact, mark experimental

just setting expectations
ipfs · Aug 19, 2024 · 577677c · 577677c
1 parent b549434
commit 577677c
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/core/commands/add.go b/core/commands/add.go
@@ -197,8 +197,8 @@ See 'dag export' and 'dag import' for more information.
 
 		cmds.BoolOption(preserveModeOptionName, "Apply existing POSIX permissions to created UnixFS entries"),
 		cmds.BoolOption(preserveMtimeOptionName, "Apply existing POSIX modification time to created UnixFS entries"),
-		cmds.UintOption(modeOptionName, "Custom POSIX file mode to store in created UnixFS entries"),
-		cmds.Int64Option(mtimeOptionName, "Custom POSIX modification time to store in created UnixFS entries (seconds before or after the Unix Epoch)"),
+		cmds.UintOption(modeOptionName, "Custom POSIX file mode to store in created UnixFS entries. Disables raw-leaves. (experimental)"),
+		cmds.Int64Option(mtimeOptionName, "Custom POSIX modification time to store in created UnixFS entries (seconds before or after the Unix Epoch). Disables raw-leaves. (experimental)"),
 		cmds.UintOption(mtimeNsecsOptionName, "Custom POSIX modification time (optional time fraction in nanoseconds)"),
 	},
 	PreRun: func(req *cmds.Request, env cmds.Environment) error {

diff --git a/docs/changelogs/v0.30.md b/docs/changelogs/v0.30.md
@@ -106,6 +106,10 @@ The CLI and HTTP RPC options `--mode`, `--mtime` and `--mtime-nsecs` can be used
 
 Opt-in support for `mode` and `mtime` was also added to MFS (`ipfs files --help`). For more information see `--help` text of `ipfs files touch|stat|chmod` commands.
 
+
+> [!NOTE]
+> Storing `mode` and `mtime` requires root block to be `dag-pb` and disabled `raw-leaves` setting to create envelope for storing the metadata.
+
 ### 📝 Changelog
 
 ### 👨‍👩‍👧‍👦 Contributors