filestore util: add documentation for 'filestore ls' and 'verify' commands.
License: MIT Signed-off-by: Kevin Atkinson <k@kevina.org>
Kevin Atkinson committed
Feb 3, 2017 at 20:46 UTC
064bb538843765392a7f4f1b7cb5a0bc8f4a5144
1 file changed
+30
core/commands/filestore.go
+30
@@ -24,6 +24,16 @@ var FileStoreCmd = &cmds.Command{
24
var lsFileStore = &cmds.Command{
25
Helptext: cmds.HelpText{
26
Tagline: "List objects in filestore.",
27
+ LongDescription: `
28
+List objects in the filestore.
29
+
30
+If one or more <obj> is specified only list those specific objects,
31
+otherwise list all objects.
32
+
33
+The output is:
34
+
35
+<hash> <size> <path> <offset>
36
+`,
37
},
38
Arguments: []cmds.Argument{
39
cmds.StringArg("obj", false, true, "Cid of objects to list."),
@@ -80,6 +90,26 @@ var lsFileStore = &cmds.Command{
90
var verifyFileStore = &cmds.Command{
91
Helptext: cmds.HelpText{
92
Tagline: "Verify objects in filestore.",
93
+ LongDescription: `
94
+Verify objects in the filestore.
95
+
96
+If one or more <obj> is specified only verify those specific objects,
97
+otherwise verify all objects.
98
+
99
+The output is:
100
+
101
+<status> <hash> <size> <path> <offset>
102
+
103
+Where <status> is one of:
104
+ok: the block can be reconstructed
105
+changed: the contents of the backing file have changed
106
+no-file: the backing file could not be found
107
+error: there was some other problem reading the file
108
+missing: <obj> could not be found in the filestore
109
+ERROR: internal error, most likely due to a corrupt database
110
+
111
+For ERROR entries the error will also be printed to stderr.
112
+`,
113
},
114
Arguments: []cmds.Argument{
115
cmds.StringArg("obj", false, true, "Cid of objects to verify."),