From 493c670a2b5a8a4c059d1ef0b24685445bf490d1 Mon Sep 17 00:00:00 2001 From: Alan Shaw Date: Fri, 14 Dec 2018 15:35:10 +0000 Subject: [PATCH] docs: add note about CIDv0 base encoding for bitswap and object APIs License: MIT Signed-off-by: Alan Shaw --- src/cli/commands/object/get.js | 2 +- src/cli/commands/object/links.js | 2 +- src/cli/commands/object/new.js | 2 +- src/cli/commands/object/patch/add-link.js | 2 +- src/cli/commands/object/patch/append-data.js | 2 +- src/cli/commands/object/patch/rm-link.js | 2 +- src/cli/commands/object/patch/set-data.js | 2 +- src/cli/commands/object/put.js | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) diff --git a/src/cli/commands/object/get.js b/src/cli/commands/object/get.js index e48864a1c2..456449492c 100644 --- 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 index f40ae621a0..768e42150c 100644 --- 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 index 58da80c723..d48f4c69ee 100644 --- 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 index ccbeb2cedb..a1a573a031 100644 --- 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 index 424064aacd..b54f301f62 100644 --- 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 index 82dff38379..ca7be4e8a5 100644 --- 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 index d201ab2900..7c7209ea57 100644 --- 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 index f0bb0a6f26..c9999bb335 100644 --- 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 }