docs(cli): clarify CID determinism in add command
Better 'ipfs add --help' docs, based on feedback from https://discuss.ipfs.io/t/ipfs-for-publishing-research-data-car-files/14748
Marcin Rataj committed
Jul 20, 2022 at 14:19 UTC
0080a666396a88f942169097be24d45c00740916
1 file changed
+10
-4
core/commands/add.go
+10
-4
@@ -107,10 +107,16 @@ You can now check what blocks have been created by:
107
QmerURi9k4XzKCaaPbsK6BL5pMEjF7PGphjDvkkjDtsVf3 868
108
QmQB28iwSriSUSMqG2nXDTLtdPHgWb4rebBrU7Q1j4vxPv 338
109
110
-Finally, a note on hash determinism. While not guaranteed, adding the same
111
-file/directory with the same flags will almost always result in the same output
112
-hash. However, almost all of the flags provided by this command (other than pin,
113
-only-hash, and progress/status related flags) will change the final hash.
110
+Finally, a note on hash (CID) determinism and 'ipfs add' command.
111
+
112
+Almost all the flags provided by this command will change the final CID, and
113
+new flags may be added in the future. It is not guaranteed for the implicit
114
+defaults of 'ipfs add' to remain the same in future Kubo releases, or for other
115
+IPFS software to use the same import parameters as Kubo.
116
+
117
+If you need to back up or transport content-addressed data using a non-IPFS
118
+medium, CID can be preserved with CAR files.
119
+See 'ipfs dag export' and 'dag import' for more information.
120
`,
121
},
122