docs: ipfs object only works with dag-pb
Closes #7396
Marcin Rataj committed
Mar 24, 2021 at 20:49 UTC
f91411362baf0812150042e596292baf3854d43a
3 files changed
+23
-23
README.md
+1
-1
@@ -298,7 +298,7 @@ SUBCOMMANDS
298
DATA STRUCTURE COMMANDS
299
dag Interact with IPLD DAG nodes
300
files Interact with files as if they were a unix filesystem
301
- object Interact with objects (deprecated, use 'dag' or 'files')
301
+ object Interact with dag-pb objects (deprecated, use 'dag' or 'files')
302
block Interact with raw blocks in the datastore
303
304
ADVANCED COMMANDS
core/commands/object/object.go
+21
-21
@@ -48,9 +48,9 @@ const (
48
49
var ObjectCmd = &cmds.Command{
50
Helptext: cmds.HelpText{
51
- Tagline: "Interact with objects (deprecated, use 'dag' or 'files')",
51
+ Tagline: "Interact with dag-pb objects (deprecated, use generic 'dag')",
52
ShortDescription: `
53
-'ipfs object' is a legacy plumbing command used to manipulate DAG objects
53
+'ipfs object' is a legacy plumbing command used to manipulate dag-pb objects
54
directly. Deprecated, use more modern 'ipfs dag' and 'ipfs files' instead.`,
55
},
56
@@ -69,14 +69,14 @@ directly. Deprecated, use more modern 'ipfs dag' and 'ipfs files' instead.`,
69
// ObjectDataCmd object data command
70
var ObjectDataCmd = &cmds.Command{
71
Helptext: cmds.HelpText{
72
- Tagline: "Output the raw bytes of an IPFS object.",
72
+ Tagline: "Output the raw bytes of a dag-pb object.",
73
ShortDescription: `
74
'ipfs object data' is a plumbing command for retrieving the raw bytes stored
75
-in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
75
+in a dag-pb node. It outputs to stdout, and <key> is a base58 encoded multihash.
76
`,
77
LongDescription: `
78
'ipfs object data' is a plumbing command for retrieving the raw bytes stored
79
-in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
79
+in a dag-pb node. It outputs to stdout, and <key> is a base58 encoded multihash.
80
81
Note that the "--encoding" option does not affect the output, since the output
82
is the raw data of the object.
@@ -106,16 +106,16 @@ is the raw data of the object.
106
// ObjectLinksCmd object links command
107
var ObjectLinksCmd = &cmds.Command{
108
Helptext: cmds.HelpText{
109
- Tagline: "Output the links pointed to by the specified object.",
109
+ Tagline: "Output the links pointed to by the specified dag-pb object.",
110
ShortDescription: `
111
'ipfs object links' is a plumbing command for retrieving the links from
112
-a DAG node. It outputs to stdout, and <key> is a base58 encoded
112
+a dag-pb node. It outputs to stdout, and <key> is a base58 encoded
113
multihash.
114
`,
115
},
116
117
Arguments: []cmds.Argument{
118
- cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
118
+ cmds.StringArg("key", true, false, "Key of the dag-pb object to retrieve, in base58-encoded multihash format.").EnableStdin(),
119
},
120
Options: []cmds.Option{
121
cmds.BoolOption(headersOptionName, "v", "Print table headers (Hash, Size, Name)."),
@@ -180,14 +180,14 @@ multihash.
180
// ObjectGetCmd object get command
181
var ObjectGetCmd = &cmds.Command{
182
Helptext: cmds.HelpText{
183
- Tagline: "Get and serialize the DAG node named by <key>.",
183
+ Tagline: "Get and serialize the dag-pb node named by <key>.",
184
ShortDescription: `
185
-'ipfs object get' is a plumbing command for retrieving DAG nodes.
185
+'ipfs object get' is a plumbing command for retrieving dag-pb nodes.
186
It serializes the DAG node to the format specified by the "--encoding"
187
flag. It outputs to stdout, and <key> is a base58 encoded multihash.
188
`,
189
LongDescription: `
190
-'ipfs object get' is a plumbing command for retrieving DAG nodes.
190
+'ipfs object get' is a plumbing command for retrieving dag-pb nodes.
191
It serializes the DAG node to the format specified by the "--encoding"
192
flag. It outputs to stdout, and <key> is a base58 encoded multihash.
193
@@ -207,7 +207,7 @@ Supported values are:
207
},
208
209
Arguments: []cmds.Argument{
210
- cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
210
+ cmds.StringArg("key", true, false, "Key of the dag-pb object to retrieve, in base58-encoded multihash format.").EnableStdin(),
211
},
212
Options: []cmds.Option{
213
cmds.StringOption(encodingOptionName, "Encoding type of the data field, either \"text\" or \"base64\".").WithDefault("text"),
@@ -287,9 +287,9 @@ Supported values are:
287
// ObjectStatCmd object stat command
288
var ObjectStatCmd = &cmds.Command{
289
Helptext: cmds.HelpText{
290
- Tagline: "Get stats for the DAG node named by <key>.",
290
+ Tagline: "Get stats for the dag-pb node named by <key>.",
291
ShortDescription: `
292
-'ipfs object stat' is a plumbing command to print DAG node statistics.
292
+'ipfs object stat' is a plumbing command to print dag-pb node statistics.
293
<key> is a base58 encoded multihash. It outputs to stdout:
294
295
NumLinks int number of links in link table
@@ -360,13 +360,13 @@ var ObjectStatCmd = &cmds.Command{
360
// ObjectPutCmd object put command
361
var ObjectPutCmd = &cmds.Command{
362
Helptext: cmds.HelpText{
363
- Tagline: "Store input as a DAG object, print its key.",
363
+ Tagline: "Store input as a dag-pb object, print its key.",
364
ShortDescription: `
365
-'ipfs object put' is a plumbing command for storing DAG nodes.
365
+'ipfs object put' is a plumbing command for storing dag-pb nodes.
366
It reads from stdin, and the output is a base58 encoded multihash.
367
`,
368
LongDescription: `
369
-'ipfs object put' is a plumbing command for storing DAG nodes.
369
+'ipfs object put' is a plumbing command for storing dag-pb nodes.
370
It reads from stdin, and the output is a base58 encoded multihash.
371
372
Data should be in the format specified by the --inputenc flag.
@@ -397,7 +397,7 @@ And then run:
397
},
398
399
Arguments: []cmds.Argument{
400
- cmds.FileArg("data", true, false, "Data to be stored as a DAG object.").EnableStdin(),
400
+ cmds.FileArg("data", true, false, "Data to be stored as a dag-pb object.").EnableStdin(),
401
},
402
Options: []cmds.Option{
403
cmds.StringOption(inputencOptionName, "Encoding type of input data. One of: {\"protobuf\", \"json\"}.").WithDefault("json"),
@@ -466,12 +466,12 @@ And then run:
466
// ObjectNewCmd object new command
467
var ObjectNewCmd = &cmds.Command{
468
Helptext: cmds.HelpText{
469
- Tagline: "Create a new object from an IPFS template.",
469
+ Tagline: "Create a new dag-pb object from a template.",
470
ShortDescription: `
471
-'ipfs object new' is a plumbing command for creating new DAG nodes.
471
+'ipfs object new' is a plumbing command for creating new dag-pb nodes.
472
`,
473
LongDescription: `
474
-'ipfs object new' is a plumbing command for creating new DAG nodes.
474
+'ipfs object new' is a plumbing command for creating new dag-pb nodes.
475
By default it creates and returns a new empty merkledag node, but
476
you may pass an optional template argument to create a preformatted
477
node.
core/commands/root.go
+1
-1
@@ -42,7 +42,7 @@ BASIC COMMANDS
42
DATA STRUCTURE COMMANDS
43
dag Interact with IPLD DAG nodes
44
files Interact with files as if they were a unix filesystem
45
- object Interact with objects (deprecated, use 'dag' or 'files')
45
+ object Interact with dag-pb objects (deprecated, use 'dag' or 'files')
46
block Interact with raw blocks in the datastore
47
48
ADVANCED COMMANDS