From f91411362baf0812150042e596292baf3854d43a Mon Sep 17 00:00:00 2001 From: Marcin Rataj Date: Wed, 24 Mar 2021 20:49:50 +0100 Subject: [PATCH] docs: ipfs object only works with dag-pb Closes #7396 --- README.md | 2 +- core/commands/object/object.go | 42 +++++++++++++++++----------------- core/commands/root.go | 2 +- 3 files changed, 23 insertions(+), 23 deletions(-) diff --git a/README.md b/README.md index b292d778a..f7ffa719e 100644 --- a/README.md +++ b/README.md @@ -298,7 +298,7 @@ SUBCOMMANDS DATA STRUCTURE COMMANDS dag Interact with IPLD DAG nodes files Interact with files as if they were a unix filesystem - object Interact with objects (deprecated, use 'dag' or 'files') + object Interact with dag-pb objects (deprecated, use 'dag' or 'files') block Interact with raw blocks in the datastore ADVANCED COMMANDS diff --git a/core/commands/object/object.go b/core/commands/object/object.go index 9ed682758..1e52f2315 100644 --- a/core/commands/object/object.go +++ b/core/commands/object/object.go @@ -48,9 +48,9 @@ const ( var ObjectCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Interact with objects (deprecated, use 'dag' or 'files')", + Tagline: "Interact with dag-pb objects (deprecated, use generic 'dag')", ShortDescription: ` -'ipfs object' is a legacy plumbing command used to manipulate DAG objects +'ipfs object' is a legacy plumbing command used to manipulate dag-pb objects directly. Deprecated, use more modern 'ipfs dag' and 'ipfs files' instead.`, }, @@ -69,14 +69,14 @@ directly. Deprecated, use more modern 'ipfs dag' and 'ipfs files' instead.`, // ObjectDataCmd object data command var ObjectDataCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Output the raw bytes of an IPFS object.", + Tagline: "Output the raw bytes of a dag-pb object.", ShortDescription: ` 'ipfs object data' is a plumbing command for retrieving the raw bytes stored -in a DAG node. It outputs to stdout, and is a base58 encoded multihash. +in a dag-pb node. It outputs to stdout, and is a base58 encoded multihash. `, LongDescription: ` 'ipfs object data' is a plumbing command for retrieving the raw bytes stored -in a DAG node. It outputs to stdout, and is a base58 encoded multihash. +in a dag-pb node. It outputs to stdout, and is a base58 encoded multihash. Note that the "--encoding" option does not affect the output, since the output is the raw data of the object. @@ -106,16 +106,16 @@ is the raw data of the object. // ObjectLinksCmd object links command var ObjectLinksCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Output the links pointed to by the specified object.", + Tagline: "Output the links pointed to by the specified dag-pb object.", ShortDescription: ` 'ipfs object links' is a plumbing command for retrieving the links from -a DAG node. It outputs to stdout, and is a base58 encoded +a dag-pb node. It outputs to stdout, and is a base58 encoded multihash. `, }, Arguments: []cmds.Argument{ - cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(), + cmds.StringArg("key", true, false, "Key of the dag-pb object to retrieve, in base58-encoded multihash format.").EnableStdin(), }, Options: []cmds.Option{ cmds.BoolOption(headersOptionName, "v", "Print table headers (Hash, Size, Name)."), @@ -180,14 +180,14 @@ multihash. // ObjectGetCmd object get command var ObjectGetCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Get and serialize the DAG node named by .", + Tagline: "Get and serialize the dag-pb node named by .", ShortDescription: ` -'ipfs object get' is a plumbing command for retrieving DAG nodes. +'ipfs object get' is a plumbing command for retrieving dag-pb nodes. It serializes the DAG node to the format specified by the "--encoding" flag. It outputs to stdout, and is a base58 encoded multihash. `, LongDescription: ` -'ipfs object get' is a plumbing command for retrieving DAG nodes. +'ipfs object get' is a plumbing command for retrieving dag-pb nodes. It serializes the DAG node to the format specified by the "--encoding" flag. It outputs to stdout, and is a base58 encoded multihash. @@ -207,7 +207,7 @@ Supported values are: }, Arguments: []cmds.Argument{ - cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(), + cmds.StringArg("key", true, false, "Key of the dag-pb object to retrieve, in base58-encoded multihash format.").EnableStdin(), }, Options: []cmds.Option{ cmds.StringOption(encodingOptionName, "Encoding type of the data field, either \"text\" or \"base64\".").WithDefault("text"), @@ -287,9 +287,9 @@ Supported values are: // ObjectStatCmd object stat command var ObjectStatCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Get stats for the DAG node named by .", + Tagline: "Get stats for the dag-pb node named by .", ShortDescription: ` -'ipfs object stat' is a plumbing command to print DAG node statistics. +'ipfs object stat' is a plumbing command to print dag-pb node statistics. is a base58 encoded multihash. It outputs to stdout: NumLinks int number of links in link table @@ -360,13 +360,13 @@ var ObjectStatCmd = &cmds.Command{ // ObjectPutCmd object put command var ObjectPutCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Store input as a DAG object, print its key.", + Tagline: "Store input as a dag-pb object, print its key.", ShortDescription: ` -'ipfs object put' is a plumbing command for storing DAG nodes. +'ipfs object put' is a plumbing command for storing dag-pb nodes. It reads from stdin, and the output is a base58 encoded multihash. `, LongDescription: ` -'ipfs object put' is a plumbing command for storing DAG nodes. +'ipfs object put' is a plumbing command for storing dag-pb nodes. It reads from stdin, and the output is a base58 encoded multihash. Data should be in the format specified by the --inputenc flag. @@ -397,7 +397,7 @@ And then run: }, Arguments: []cmds.Argument{ - cmds.FileArg("data", true, false, "Data to be stored as a DAG object.").EnableStdin(), + cmds.FileArg("data", true, false, "Data to be stored as a dag-pb object.").EnableStdin(), }, Options: []cmds.Option{ cmds.StringOption(inputencOptionName, "Encoding type of input data. One of: {\"protobuf\", \"json\"}.").WithDefault("json"), @@ -466,12 +466,12 @@ And then run: // ObjectNewCmd object new command var ObjectNewCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Create a new object from an IPFS template.", + Tagline: "Create a new dag-pb object from a template.", ShortDescription: ` -'ipfs object new' is a plumbing command for creating new DAG nodes. +'ipfs object new' is a plumbing command for creating new dag-pb nodes. `, LongDescription: ` -'ipfs object new' is a plumbing command for creating new DAG nodes. +'ipfs object new' is a plumbing command for creating new dag-pb nodes. By default it creates and returns a new empty merkledag node, but you may pass an optional template argument to create a preformatted node. diff --git a/core/commands/root.go b/core/commands/root.go index 7decb8b9b..fff4623e6 100644 --- a/core/commands/root.go +++ b/core/commands/root.go @@ -42,7 +42,7 @@ BASIC COMMANDS DATA STRUCTURE COMMANDS dag Interact with IPLD DAG nodes files Interact with files as if they were a unix filesystem - object Interact with objects (deprecated, use 'dag' or 'files') + object Interact with dag-pb objects (deprecated, use 'dag' or 'files') block Interact with raw blocks in the datastore ADVANCED COMMANDS