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

Alan Shaw · Alan Shaw · commit 493c670a2b5a · 2018-12-14T15:35:10.000Z
License: MIT
Signed-off-by: Alan Shaw &lt;alan.shaw@protocol.ai&gt;
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
     }

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@ module.exports = {`
`15`	`15`	`default: 'base64'`
`16`	`16`	`},`
`17`	`17`	`'cid-base': {`
`18`		`- describe: 'Number base to display CIDs in.',`
	`18`	`+ describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',`
`19`	`19`	`type: 'string',`
`20`	`20`	`choices: multibase.names`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ module.exports = {`
`11`	`11`
`12`	`12`	`builder: {`
`13`	`13`	`'cid-base': {`
`14`		`- describe: 'Number base to display CIDs in.',`
	`14`	`+ describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',`
`15`	`15`	`type: 'string',`
`16`	`16`	`choices: multibase.names`
`17`	`17`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ module.exports = {`
`13`	`13`
`14`	`14`	`builder: {`
`15`	`15`	`'cid-base': {`
`16`		`- describe: 'Number base to display CIDs in.',`
	`16`	`+ describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',`
`17`	`17`	`type: 'string',`
`18`	`18`	`choices: multibase.names`
`19`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@ module.exports = {`
`25`	`25`
`26`	`26`	`builder: {`
`27`	`27`	`'cid-base': {`
`28`		`- describe: 'Number base to display CIDs in.',`
	`28`	`+ describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',`
`29`	`29`	`type: 'string',`
`30`	`30`	`choices: multibase.names`
`31`	`31`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ module.exports = {`
`27`	`27`	`default: 'json'`
`28`	`28`	`},`
`29`	`29`	`'cid-base': {`
`30`		`- describe: 'Number base to display CIDs in.',`
	`30`	`+ describe: 'Number base to display CIDs in. Note: specifying a CID base for v0 CIDs will have no effect.',`
`31`	`31`	`type: 'string',`
`32`	`32`	`choices: multibase.names`
`33`	`33`	`}`