1
0
mirror of https://github.com/ipfs/kubo.git synced 2025-06-29 01:12:24 +08:00

Linted object diff help text

License: MIT
Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
This commit is contained in:
Richard Littauer
2016-05-09 10:21:17 -04:00
parent 00f9ce6c48
commit f6e88d7404

View File

@ -17,37 +17,37 @@ type Changes struct {
var ObjectDiffCmd = &cmds.Command{ var ObjectDiffCmd = &cmds.Command{
Helptext: cmds.HelpText{ Helptext: cmds.HelpText{
Tagline: "takes a diff of the two given objects", Tagline: "Takes a diff of the two given objects.",
ShortDescription: ` ShortDescription: `
ipfs object diff is a command used to show the differences between 'ipfs object diff' is a command used to show the differences between
two ipfs objects.`, two ipfs objects.`,
LongDescription: ` LongDescription: `
ipfs object diff is a command used to show the differences between 'ipfs object diff' is a command used to show the differences between
two ipfs objects. two ipfs objects.
Example: Example:
$ ls foo > ls foo
bar baz/ giraffe bar baz/ giraffe
$ ipfs add -r foo > ipfs add -r foo
... ...
added QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz foo Added QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz foo
$ OBJ_A=QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz > OBJ_A=QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz
$ echo "different content" > foo/bar > echo "different content" > foo/bar
$ ipfs add -r foo > ipfs add -r foo
... ...
added QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD foo Added QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD foo
$ OBJ_B=QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD > OBJ_B=QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD
$ ipfs object diff -v $OBJ_A $OBJ_B > ipfs object diff -v $OBJ_A $OBJ_B
changed "bar" from QmNgd5cz2jNftnAHBhcRUGdtiaMzb5Rhjqd4etondHHST8 to QmRfFVsjSXkhFxrfWnLpMae2M4GBVsry6VAuYYcji5MiZb Changed "bar" from QmNgd5cz2jNftnAHBhcRUGdtiaMzb5Rhjqd4etondHHST8 to QmRfFVsjSXkhFxrfWnLpMae2M4GBVsry6VAuYYcji5MiZb.
`, `,
}, },
Arguments: []cmds.Argument{ Arguments: []cmds.Argument{
cmds.StringArg("obj_a", true, false, "object to diff against"), cmds.StringArg("obj_a", true, false, "Object to diff against."),
cmds.StringArg("obj_b", true, false, "object to diff"), cmds.StringArg("obj_b", true, false, "Object to diff."),
}, },
Options: []cmds.Option{ Options: []cmds.Option{
cmds.BoolOption("verbose", "v", "Produce verbose output"), cmds.BoolOption("verbose", "v", "Produce verbose output."),
}, },
Run: func(req cmds.Request, res cmds.Response) { Run: func(req cmds.Request, res cmds.Response) {
node, err := req.InvocContext().GetNode() node, err := req.InvocContext().GetNode()
@ -103,11 +103,11 @@ Example:
if verbose { if verbose {
switch change.Type { switch change.Type {
case dagutils.Add: case dagutils.Add:
fmt.Fprintf(buf, "added new link %q pointing to %s\n", change.Path, change.After) fmt.Fprintf(buf, "Added new link %q pointing to %s.\n", change.Path, change.After)
case dagutils.Mod: case dagutils.Mod:
fmt.Fprintf(buf, "changed %q from %s to %s\n", change.Path, change.Before, change.After) fmt.Fprintf(buf, "Changed %q from %s to %s.\n", change.Path, change.Before, change.After)
case dagutils.Remove: case dagutils.Remove:
fmt.Fprintf(buf, "removed link %q (was %s)\n", change.Path, change.Before) fmt.Fprintf(buf, "Removed link %q (was %s).\n", change.Path, change.Before)
} }
} else { } else {
switch change.Type { switch change.Type {