Linted object diff help text
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
May 9, 2016 at 10:21 UTC
f6e88d7404685ec85e62df4c6732875fcd5c45cf
1 file changed
+19
-19
core/commands/object/diff.go
+19
-19
@@ -17,37 +17,37 @@ type Changes struct {
17
18
var ObjectDiffCmd = &cmds.Command{
19
Helptext: cmds.HelpText{
20
- Tagline: "takes a diff of the two given objects",
20
+ Tagline: "Takes a diff of the two given objects.",
21
ShortDescription: `
22
-ipfs object diff is a command used to show the differences between
22
+'ipfs object diff' is a command used to show the differences between
23
two ipfs objects.`,
24
LongDescription: `
25
-ipfs object diff is a command used to show the differences between
25
+'ipfs object diff' is a command used to show the differences between
26
two ipfs objects.
27
28
Example:
29
30
- $ ls foo
30
+ > ls foo
31
bar baz/ giraffe
32
- $ ipfs add -r foo
32
+ > ipfs add -r foo
33
...
34
- added QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz foo
35
- $ OBJ_A=QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz
36
- $ echo "different content" > foo/bar
37
- $ ipfs add -r foo
34
+ Added QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz foo
35
+ > OBJ_A=QmegHcnrPgMwC7tBiMxChD54fgQMBUecNw9nE9UUU4x1bz
36
+ > echo "different content" > foo/bar
37
+ > ipfs add -r foo
38
...
39
- added QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD foo
40
- $ OBJ_B=QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD
41
- $ ipfs object diff -v $OBJ_A $OBJ_B
42
- changed "bar" from QmNgd5cz2jNftnAHBhcRUGdtiaMzb5Rhjqd4etondHHST8 to QmRfFVsjSXkhFxrfWnLpMae2M4GBVsry6VAuYYcji5MiZb
39
+ Added QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD foo
40
+ > OBJ_B=QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD
41
+ > ipfs object diff -v $OBJ_A $OBJ_B
42
+ Changed "bar" from QmNgd5cz2jNftnAHBhcRUGdtiaMzb5Rhjqd4etondHHST8 to QmRfFVsjSXkhFxrfWnLpMae2M4GBVsry6VAuYYcji5MiZb.
43
`,
44
},
45
Arguments: []cmds.Argument{
46
- cmds.StringArg("obj_a", true, false, "object to diff against"),
47
- cmds.StringArg("obj_b", true, false, "object to diff"),
46
+ cmds.StringArg("obj_a", true, false, "Object to diff against."),
47
+ cmds.StringArg("obj_b", true, false, "Object to diff."),
48
},
49
Options: []cmds.Option{
50
- cmds.BoolOption("verbose", "v", "Produce verbose output"),
50
+ cmds.BoolOption("verbose", "v", "Produce verbose output."),
51
},
52
Run: func(req cmds.Request, res cmds.Response) {
53
node, err := req.InvocContext().GetNode()
@@ -103,11 +103,11 @@ Example:
103
if verbose {
104
switch change.Type {
105
case dagutils.Add:
106
- fmt.Fprintf(buf, "added new link %q pointing to %s\n", change.Path, change.After)
106
+ fmt.Fprintf(buf, "Added new link %q pointing to %s.\n", change.Path, change.After)
107
case dagutils.Mod:
108
- fmt.Fprintf(buf, "changed %q from %s to %s\n", change.Path, change.Before, change.After)
108
+ fmt.Fprintf(buf, "Changed %q from %s to %s.\n", change.Path, change.Before, change.After)
109
case dagutils.Remove:
110
- fmt.Fprintf(buf, "removed link %q (was %s)\n", change.Path, change.Before)
110
+ fmt.Fprintf(buf, "Removed link %q (was %s).\n", change.Path, change.Before)
111
}
112
} else {
113
switch change.Type {