From 2492f0cb38ced0a32ac1ac8b0119162dbb8c928f Mon Sep 17 00:00:00 2001 From: Jeromy Date: Wed, 23 Sep 2015 10:41:51 -0700 Subject: [PATCH] document the set-data and append-data commands in patch License: MIT Signed-off-by: Jeromy --- core/commands/object.go | 18 ++++++++++++++++-- 1 file changed, 16 insertions(+), 2 deletions(-) diff --git a/core/commands/object.go b/core/commands/object.go index e7ae1c931..e8929c61f 100644 --- a/core/commands/object.go +++ b/core/commands/object.go @@ -433,9 +433,17 @@ var objectPatchCmd = &cmds.Command{ Helptext: cmds.HelpText{ Tagline: "Create a new merkledag object based on an existing one", ShortDescription: ` -'ipfs object patch [add-link|rm-link] ' is a plumbing command used to +'ipfs object patch ' is a plumbing command used to build custom DAG objects. It adds and removes links from objects, creating a new -object as a result. This is the merkle-dag version of modifying an object. +object as a result. This is the merkle-dag version of modifying an object. It +can also set the data inside a node with 'set-data' and append to that data as +well with 'append-data'. + +Patch commands: + add-link - adds a link to a node + rm-link - removes a link from a node + set-data - sets a nodes data from stdin + append-data - appends to a nodes data from stdin Examples: @@ -450,6 +458,12 @@ a file containing 'bar', and returns the hash of the new object. This removes the link named foo from the hash in $FOO_BAR and returns the resulting object hash. + +The data inside the node can be modified as well: + + ipfs object patch $FOO_BAR set-data < file.dat + ipfs object patch $FOO_BAR append-data < file.dat + `, }, Options: []cmds.Option{