docs: add note about CIDv0 base encoding for bitswap and object APIs

License: MIT Signed-off-by: Alan Shaw <alan.shaw@protocol.ai>
ipfs · Dec 14, 2018 · 493c670 · 493c670
1 parent 0295b2f
commit 493c670
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/src/cli/commands/object/get.js b/src/cli/commands/object/get.js
@@ -15,7 +15,7 @@ module.exports = {
       default: 'base64'
     },
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }

diff --git a/src/cli/commands/object/links.js b/src/cli/commands/object/links.js
@@ -11,7 +11,7 @@ module.exports = {
 
   builder: {
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }

diff --git a/src/cli/commands/object/new.js b/src/cli/commands/object/new.js
@@ -11,7 +11,7 @@ module.exports = {
 
   builder: {
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }

diff --git a/src/cli/commands/object/patch/add-link.js b/src/cli/commands/object/patch/add-link.js
@@ -13,7 +13,7 @@ module.exports = {
 
   builder: {
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }

diff --git a/src/cli/commands/object/patch/append-data.js b/src/cli/commands/object/patch/append-data.js
@@ -25,7 +25,7 @@ module.exports = {
 
   builder: {
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }

diff --git a/src/cli/commands/object/patch/rm-link.js b/src/cli/commands/object/patch/rm-link.js
@@ -11,7 +11,7 @@ module.exports = {
 
   builder: {
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }

diff --git a/src/cli/commands/object/patch/set-data.js b/src/cli/commands/object/patch/set-data.js
@@ -25,7 +25,7 @@ module.exports = {
 
   builder: {
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }

diff --git a/src/cli/commands/object/put.js b/src/cli/commands/object/put.js
@@ -27,7 +27,7 @@ module.exports = {
       default: 'json'
     },
     'cid-base': {
-      describe: 'Number base to display CIDs in.',
+      describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',
       type: 'string',
       choices: multibase.names
     }