Capitalized beginning of line messages, added periods
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
Richard Littauer committed
Jan 24, 2016 at 19:25 UTC
28fe2e4f4cb837a463fa912e7054cf8a95f27800
32 files changed
+121
-121
cmd/ipfs/init.go
+3
-3
@@ -35,13 +35,13 @@ at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable
35
36
Options: []cmds.Option{
37
cmds.IntOption("bits", "b", fmt.Sprintf("Number of bits to use in the generated RSA private key (defaults to %d)", nBitsForKeypairDefault)),
38
- cmds.BoolOption("force", "f", "Overwrite existing config (if it exists)"),
39
- cmds.BoolOption("empty-repo", "e", "Don't add and pin help files to the local storage"),
38
+ cmds.BoolOption("force", "f", "Overwrite existing config (if it exists)."),
39
+ cmds.BoolOption("empty-repo", "e", "Don't add and pin help files to the local storage."),
40
41
// TODO need to decide whether to expose the override as a file or a
42
// directory. That is: should we allow the user to also specify the
43
// name of the file?
44
- // TODO cmds.StringOption("event-logs", "l", "Location for machine-readable event logs"),
44
+ // TODO cmds.StringOption("event-logs", "l", "Location for machine-readable event logs."),
45
},
46
PreRun: func(req cmds.Request) error {
47
daemonLocked, err := fsrepo.LockedByOtherProcess(req.InvocContext().ConfigRoot)
core/commands/add.go
+1
-1
@@ -39,7 +39,7 @@ MerkleDAG.
39
},
40
41
Arguments: []cmds.Argument{
42
- cmds.FileArg("path", true, true, "The path to a file to be added to IPFS").EnableRecursive().EnableStdin(),
42
+ cmds.FileArg("path", true, true, "The path to a file to be added to IPFS.").EnableRecursive().EnableStdin(),
43
},
44
Options: []cmds.Option{
45
cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)
core/commands/block.go
+3
-3
@@ -55,7 +55,7 @@ on raw ipfs blocks. It outputs the following to stdout:
55
},
56
57
Arguments: []cmds.Argument{
58
- cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get").EnableStdin(),
58
+ cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get.").EnableStdin(),
59
},
60
Run: func(req cmds.Request, res cmds.Response) {
61
b, err := getBlockForKey(req, req.Arguments()[0])
@@ -88,7 +88,7 @@ It outputs to stdout, and <key> is a base58 encoded multihash.
88
},
89
90
Arguments: []cmds.Argument{
91
- cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get").EnableStdin(),
91
+ cmds.StringArg("key", true, false, "The base58 multihash of an existing block to get.").EnableStdin(),
92
},
93
Run: func(req cmds.Request, res cmds.Response) {
94
b, err := getBlockForKey(req, req.Arguments()[0])
@@ -111,7 +111,7 @@ It reads from stdin, and <key> is a base58 encoded multihash.
111
},
112
113
Arguments: []cmds.Argument{
114
- cmds.FileArg("data", true, false, "The data to be stored as an IPFS block").EnableStdin(),
114
+ cmds.FileArg("data", true, false, "The data to be stored as an IPFS block.").EnableStdin(),
115
},
116
Run: func(req cmds.Request, res cmds.Response) {
117
n, err := req.InvocContext().GetNode()
core/commands/bootstrap.go
+1
-1
@@ -56,7 +56,7 @@ in the bootstrap list).
56
},
57
58
Options: []cmds.Option{
59
- cmds.BoolOption("default", "add default bootstrap nodes"),
59
+ cmds.BoolOption("default", "Add default bootstrap nodes."),
60
},
61
62
Run: func(req cmds.Request, res cmds.Response) {
core/commands/cat.go
+1
-1
@@ -23,7 +23,7 @@ it contains.
23
},
24
25
Arguments: []cmds.Argument{
26
- cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to be outputted").EnableStdin(),
26
+ cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to be outputted.").EnableStdin(),
27
},
28
Run: func(req cmds.Request, res cmds.Response) {
29
node, err := req.InvocContext().GetNode()
core/commands/config.go
+5
-5
@@ -54,12 +54,12 @@ Set the value of the 'datastore.path' key:
54
},
55
56
Arguments: []cmds.Argument{
57
- cmds.StringArg("key", true, false, "The key of the config entry (e.g. \"Addresses.API\")"),
58
- cmds.StringArg("value", false, false, "The value to set the config entry to"),
57
+ cmds.StringArg("key", true, false, "The key of the config entry (e.g. \"Addresses.API\")."),
58
+ cmds.StringArg("value", false, false, "The value to set the config entry to."),
59
},
60
Options: []cmds.Option{
61
- cmds.BoolOption("bool", "Set a boolean value"),
62
- cmds.BoolOption("json", "Parse stringified JSON"),
61
+ cmds.BoolOption("bool", "Set a boolean value."),
62
+ cmds.BoolOption("json", "Parse stringified JSON."),
63
},
64
Run: func(req cmds.Request, res cmds.Response) {
65
args := req.Arguments()
@@ -189,7 +189,7 @@ can't be undone.
189
},
190
191
Arguments: []cmds.Argument{
192
- cmds.FileArg("file", true, false, "The file to use as the new config"),
192
+ cmds.FileArg("file", true, false, "The file to use as the new config."),
193
},
194
Run: func(req cmds.Request, res cmds.Response) {
195
r, err := fsrepo.Open(req.InvocContext().ConfigRoot)
core/commands/dht.go
+10
-10
@@ -40,10 +40,10 @@ var queryDhtCmd = &cmds.Command{
40
},
41
42
Arguments: []cmds.Argument{
43
- cmds.StringArg("peerID", true, true, "The peerID to run the query against"),
43
+ cmds.StringArg("peerID", true, true, "The peerID to run the query against."),
44
},
45
Options: []cmds.Option{
46
- cmds.BoolOption("verbose", "v", "Write extra information"),
46
+ cmds.BoolOption("verbose", "v", "Write extra information."),
47
},
48
Run: func(req cmds.Request, res cmds.Response) {
49
n, err := req.InvocContext().GetNode()
@@ -126,10 +126,10 @@ FindProviders will return a list of peers who are able to provide the value requ
126
},
127
128
Arguments: []cmds.Argument{
129
- cmds.StringArg("key", true, true, "The key to find providers for"),
129
+ cmds.StringArg("key", true, true, "The key to find providers for."),
130
},
131
Options: []cmds.Option{
132
- cmds.BoolOption("verbose", "v", "Write extra information"),
132
+ cmds.BoolOption("verbose", "v", "Write extra information."),
133
},
134
Run: func(req cmds.Request, res cmds.Response) {
135
n, err := req.InvocContext().GetNode()
@@ -227,7 +227,7 @@ var findPeerDhtCmd = &cmds.Command{
227
},
228
229
Arguments: []cmds.Argument{
230
- cmds.StringArg("peerID", true, true, "The peer to search for"),
230
+ cmds.StringArg("peerID", true, true, "The peer to search for."),
231
},
232
Run: func(req cmds.Request, res cmds.Response) {
233
n, err := req.InvocContext().GetNode()
@@ -324,10 +324,10 @@ GetValue will return the value stored in the dht at the given key.
324
},
325
326
Arguments: []cmds.Argument{
327
- cmds.StringArg("key", true, true, "The key to find a value for"),
327
+ cmds.StringArg("key", true, true, "The key to find a value for."),
328
},
329
Options: []cmds.Option{
330
- cmds.BoolOption("verbose", "v", "Write extra information"),
330
+ cmds.BoolOption("verbose", "v", "Write extra information."),
331
},
332
Run: func(req cmds.Request, res cmds.Response) {
333
n, err := req.InvocContext().GetNode()
@@ -427,11 +427,11 @@ PutValue will store the given key value pair in the dht.
427
},
428
429
Arguments: []cmds.Argument{
430
- cmds.StringArg("key", true, false, "The key to store the value at"),
431
- cmds.StringArg("value", true, false, "The value to store").EnableStdin(),
430
+ cmds.StringArg("key", true, false, "The key to store the value at."),
431
+ cmds.StringArg("value", true, false, "The value to store.").EnableStdin(),
432
},
433
Options: []cmds.Option{
434
- cmds.BoolOption("verbose", "v", "Write extra information"),
434
+ cmds.BoolOption("verbose", "v", "Write extra information."),
435
},
436
Run: func(req cmds.Request, res cmds.Response) {
437
n, err := req.InvocContext().GetNode()
core/commands/diag.go
+1
-1
@@ -86,7 +86,7 @@ that consume the dot format to generate graphs of the network.
86
},
87
88
Options: []cmds.Option{
89
- cmds.StringOption("vis", "output vis. one of: "+strings.Join(visFmts, ", ")),
89
+ cmds.StringOption("vis", "Output vis. one of: "+strings.Join(visFmts, ", ")),
90
},
91
92
Run: func(req cmds.Request, res cmds.Response) {
core/commands/dns.go
+1
-1
@@ -50,7 +50,7 @@ The resolver will give:
50
cmds.StringArg("domain-name", true, false, "The domain-name name to resolve.").EnableStdin(),
51
},
52
Options: []cmds.Option{
53
- cmds.BoolOption("recursive", "r", "Resolve until the result is not a DNS link"),
53
+ cmds.BoolOption("recursive", "r", "Resolve until the result is not a DNS link."),
54
},
55
Run: func(req cmds.Request, res cmds.Response) {
56
core/commands/external.go
+1
-1
@@ -14,7 +14,7 @@ import (
14
func ExternalBinary() *cmds.Command {
15
return &cmds.Command{
16
Arguments: []cmds.Argument{
17
- cmds.StringArg("args", false, true, "arguments for subcommand"),
17
+ cmds.StringArg("args", false, true, "Arguments for subcommand."),
18
},
19
External: true,
20
Run: func(req cmds.Request, res cmds.Response) {
core/commands/files/files.go
+21
-21
@@ -30,7 +30,7 @@ Files is an API for manipulating ipfs objects as if they were a unix filesystem.
30
`,
31
},
32
Options: []cmds.Option{
33
- cmds.BoolOption("f", "flush", "flush target and ancestors after write (default: true)"),
33
+ cmds.BoolOption("f", "flush", "Flush target and ancestors after write (default: true)."),
34
},
35
Subcommands: map[string]*cmds.Command{
36
"read": FilesReadCmd,
@@ -50,7 +50,7 @@ var FilesStatCmd = &cmds.Command{
50
},
51
52
Arguments: []cmds.Argument{
53
- cmds.StringArg("path", true, false, "path to node to stat"),
53
+ cmds.StringArg("path", true, false, "Path to node to stat."),
54
},
55
Run: func(req cmds.Request, res cmds.Response) {
56
node, err := req.InvocContext().GetNode()
@@ -140,8 +140,8 @@ var FilesCpCmd = &cmds.Command{
140
Tagline: "Copy files into mfs.",
141
},
142
Arguments: []cmds.Argument{
143
- cmds.StringArg("source", true, false, "source object to copy"),
144
- cmds.StringArg("dest", true, false, "destination to copy object to"),
143
+ cmds.StringArg("source", true, false, "Source object to copy."),
144
+ cmds.StringArg("dest", true, false, "Destination to copy object to."),
145
},
146
Run: func(req cmds.Request, res cmds.Response) {
147
node, err := req.InvocContext().GetNode()
@@ -228,10 +228,10 @@ Examples:
228
`,
229
},
230
Arguments: []cmds.Argument{
231
- cmds.StringArg("path", true, false, "path to show listing for"),
231
+ cmds.StringArg("path", true, false, "Path to show listing for."),
232
},
233
Options: []cmds.Option{
234
- cmds.BoolOption("l", "use long listing format"),
234
+ cmds.BoolOption("l", "Use long listing format."),
235
},
236
Run: func(req cmds.Request, res cmds.Response) {
237
path, err := checkPath(req.Arguments()[0])
@@ -323,11 +323,11 @@ Examples:
323
},
324
325
Arguments: []cmds.Argument{
326
- cmds.StringArg("path", true, false, "path to file to be read"),
326
+ cmds.StringArg("path", true, false, "Path to file to be read."),
327
},
328
Options: []cmds.Option{
329
- cmds.IntOption("o", "offset", "offset to read from"),
330
- cmds.IntOption("n", "count", "maximum number of bytes to read"),
329
+ cmds.IntOption("o", "offset", "Offset to read from."),
330
+ cmds.IntOption("n", "count", "Maximum number of bytes to read."),
331
},
332
Run: func(req cmds.Request, res cmds.Response) {
333
n, err := req.InvocContext().GetNode()
@@ -412,8 +412,8 @@ Example:
412
},
413
414
Arguments: []cmds.Argument{
415
- cmds.StringArg("source", true, false, "source file to move"),
416
- cmds.StringArg("dest", true, false, "target path for file to be moved to"),
415
+ cmds.StringArg("source", true, false, "Source file to move."),
416
+ cmds.StringArg("dest", true, false, "Target path for file to be moved to."),
417
},
418
Run: func(req cmds.Request, res cmds.Response) {
419
n, err := req.InvocContext().GetNode()
@@ -468,14 +468,14 @@ Warning:
468
`,
469
},
470
Arguments: []cmds.Argument{
471
- cmds.StringArg("path", true, false, "path to write to"),
472
- cmds.FileArg("data", true, false, "data to write").EnableStdin(),
471
+ cmds.StringArg("path", true, false, "Path to write to."),
472
+ cmds.FileArg("data", true, false, "Data to write.").EnableStdin(),
473
},
474
Options: []cmds.Option{
475
- cmds.IntOption("o", "offset", "offset to write to"),
476
- cmds.BoolOption("e", "create", "create the file if it does not exist"),
477
- cmds.BoolOption("t", "truncate", "truncate the file before writing"),
478
- cmds.IntOption("n", "count", "maximum number of bytes to read"),
475
+ cmds.IntOption("o", "offset", "Offset to write to."),
476
+ cmds.BoolOption("e", "create", "Create the file if it does not exist."),
477
+ cmds.BoolOption("t", "truncate", "Truncate the file before writing."),
478
+ cmds.IntOption("n", "count", "Maximum number of bytes to read."),
479
},
480
Run: func(req cmds.Request, res cmds.Response) {
481
path, err := checkPath(req.Arguments()[0])
@@ -580,10 +580,10 @@ Examples:
580
},
581
582
Arguments: []cmds.Argument{
583
- cmds.StringArg("path", true, false, "path to dir to make"),
583
+ cmds.StringArg("path", true, false, "Path to dir to make."),
584
},
585
Options: []cmds.Option{
586
- cmds.BoolOption("p", "parents", "no error if existing, make parent directories as needed"),
586
+ cmds.BoolOption("p", "parents", "No error if existing, make parent directories as needed."),
587
},
588
Run: func(req cmds.Request, res cmds.Response) {
589
n, err := req.InvocContext().GetNode()
@@ -629,10 +629,10 @@ remove files or directories
629
},
630
631
Arguments: []cmds.Argument{
632
- cmds.StringArg("path", true, true, "file to remove"),
632
+ cmds.StringArg("path", true, true, "File to remove."),
633
},
634
Options: []cmds.Option{
635
- cmds.BoolOption("r", "recursive", "recursively remove directories"),
635
+ cmds.BoolOption("r", "recursive", "Recursively remove directories."),
636
},
637
Run: func(req cmds.Request, res cmds.Response) {
638
nd, err := req.InvocContext().GetNode()
core/commands/get.go
+5
-5
@@ -37,13 +37,13 @@ may also specify the level of compression by specifying '-l=<1-9>'.
37
},
38
39
Arguments: []cmds.Argument{
40
- cmds.StringArg("ipfs-path", true, false, "The path to the IPFS object(s) to be outputted").EnableStdin(),
40
+ cmds.StringArg("ipfs-path", true, false, "The path to the IPFS object(s) to be outputted.").EnableStdin(),
41
},
42
Options: []cmds.Option{
43
- cmds.StringOption("output", "o", "The path where output should be stored"),
44
- cmds.BoolOption("archive", "a", "Output a TAR archive"),
45
- cmds.BoolOption("compress", "C", "Compress the output with GZIP compression"),
46
- cmds.IntOption("compression-level", "l", "The level of compression (1-9)"),
43
+ cmds.StringOption("output", "o", "The path where output should be stored."),
44
+ cmds.BoolOption("archive", "a", "Output a TAR archive."),
45
+ cmds.BoolOption("compress", "C", "Compress the output with GZIP compression."),
46
+ cmds.IntOption("compression-level", "l", "The level of compression (1-9)."),
47
},
48
PreRun: func(req cmds.Request) error {
49
_, err := getCompressOptions(req)
core/commands/id.go
+2
-2
@@ -50,10 +50,10 @@ ipfs id supports the format option for output with the following keys:
50
`,
51
},
52
Arguments: []cmds.Argument{
53
- cmds.StringArg("peerid", false, false, "peer.ID of node to look up").EnableStdin(),
53
+ cmds.StringArg("peerid", false, false, "Peer.ID of node to look up.").EnableStdin(),
54
},
55
Options: []cmds.Option{
56
- cmds.StringOption("format", "f", "optional output format"),
56
+ cmds.StringOption("format", "f", "Optional output format."),
57
},
58
Run: func(req cmds.Request, res cmds.Response) {
59
node, err := req.InvocContext().GetNode()
core/commands/ipns.go
+2
-2
@@ -44,8 +44,8 @@ Resolve the value of another name:
44
cmds.StringArg("name", false, false, "The IPNS name to resolve. Defaults to your node's peerID.").EnableStdin(),
45
},
46
Options: []cmds.Option{
47
- cmds.BoolOption("recursive", "r", "Resolve until the result is not an IPNS name"),
48
- cmds.BoolOption("nocache", "n", "Do not used cached entries"),
47
+ cmds.BoolOption("recursive", "r", "Resolve until the result is not an IPNS name."),
48
+ cmds.BoolOption("nocache", "n", "Do not used cached entries."),
49
},
50
Run: func(req cmds.Request, res cmds.Response) {
51
core/commands/log.go
+1
-1
@@ -42,7 +42,7 @@ output of a running daemon.
42
// TODO use a different keyword for 'all' because all can theoretically
43
// clash with a subsystem name
44
cmds.StringArg("subsystem", true, false, fmt.Sprintf("the subsystem logging identifier. Use '%s' for all subsystems.", logAllKeyword)),
45
- cmds.StringArg("level", true, false, "one of: debug, info, warning, error, fatal, panic"),
45
+ cmds.StringArg("level", true, false, "One of: debug, info, warning, error, fatal, panic."),
46
},
47
Run: func(req cmds.Request, res cmds.Response) {
48
core/commands/ls.go
+2
-2
@@ -41,10 +41,10 @@ it contains, with the following format:
41
},
42
43
Arguments: []cmds.Argument{
44
- cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from").EnableStdin(),
44
+ cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from.").EnableStdin(),
45
},
46
Options: []cmds.Option{
47
- cmds.BoolOption("headers", "v", "Print table headers (Hash, Name, Size)"),
47
+ cmds.BoolOption("headers", "v", "Print table headers (Hash, Name, Size)."),
48
},
49
Run: func(req cmds.Request, res cmds.Response) {
50
node, err := req.InvocContext().GetNode()
core/commands/mount_unix.go
+2
-2
@@ -93,8 +93,8 @@ baz
93
`,
94
},
95
Options: []cmds.Option{
96
- cmds.StringOption("ipfs-path", "f", "The path where IPFS should be mounted"),
97
- cmds.StringOption("ipns-path", "n", "The path where IPNS should be mounted"),
96
+ cmds.StringOption("ipfs-path", "f", "The path where IPFS should be mounted."),
97
+ cmds.StringOption("ipns-path", "n", "The path where IPNS should be mounted."),
98
},
99
Run: func(req cmds.Request, res cmds.Response) {
100
cfg, err := req.InvocContext().GetConfig()
core/commands/object/object.go
+7
-7
@@ -87,7 +87,7 @@ output is the raw data of the object.
87
},
88
89
Arguments: []cmds.Argument{
90
- cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format").EnableStdin(),
90
+ cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
91
},
92
Run: func(req cmds.Request, res cmds.Response) {
93
n, err := req.InvocContext().GetNode()
@@ -117,7 +117,7 @@ multihash.
117
},
118
119
Arguments: []cmds.Argument{
120
- cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format").EnableStdin(),
120
+ cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
121
},
122
Run: func(req cmds.Request, res cmds.Response) {
123
n, err := req.InvocContext().GetNode()
@@ -176,7 +176,7 @@ This command outputs data in the following encodings:
176
},
177
178
Arguments: []cmds.Argument{
179
- cmds.StringArg("key", true, false, "Key of the object to retrieve (in base58-encoded multihash format)").EnableStdin(),
179
+ cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
180
},
181
Run: func(req cmds.Request, res cmds.Response) {
182
n, err := req.InvocContext().GetNode()
@@ -242,7 +242,7 @@ var ObjectStatCmd = &cmds.Command{
242
},
243
244
Arguments: []cmds.Argument{
245
- cmds.StringArg("key", true, false, "Key of the object to retrieve (in base58-encoded multihash format)").EnableStdin(),
245
+ cmds.StringArg("key", true, false, "Key of the object to retrieve, in base58-encoded multihash format.").EnableStdin(),
246
},
247
Run: func(req cmds.Request, res cmds.Response) {
248
n, err := req.InvocContext().GetNode()
@@ -326,10 +326,10 @@ and then run
326
},
327
328
Arguments: []cmds.Argument{
329
- cmds.FileArg("data", true, false, "Data to be stored as a DAG object").EnableStdin(),
329
+ cmds.FileArg("data", true, false, "Data to be stored as a DAG object.").EnableStdin(),
330
},
331
Options: []cmds.Option{
332
- cmds.StringOption("inputenc", "Encoding type of input data, either \"protobuf\" or \"json\""),
332
+ cmds.StringOption("inputenc", "Encoding type of input data, either \"protobuf\" or \"json\"."),
333
},
334
Run: func(req cmds.Request, res cmds.Response) {
335
n, err := req.InvocContext().GetNode()
@@ -391,7 +391,7 @@ Available templates:
391
`,
392
},
393
Arguments: []cmds.Argument{
394
- cmds.StringArg("template", false, false, "optional template to use"),
394
+ cmds.StringArg("template", false, false, "Optional template to use."),
395
},
396
Run: func(req cmds.Request, res cmds.Response) {
397
n, err := req.InvocContext().GetNode()
core/commands/object/patch.go
+10
-10
@@ -57,8 +57,8 @@ the limit will not be respected by the network.
57
`,
58
},
59
Arguments: []cmds.Argument{
60
- cmds.StringArg("root", true, false, "the hash of the node to modify"),
61
- cmds.FileArg("data", true, false, "data to append").EnableStdin(),
60
+ cmds.StringArg("root", true, false, "The hash of the node to modify."),
61
+ cmds.FileArg("data", true, false, "Data to append.").EnableStdin(),
62
},
63
Run: func(req cmds.Request, res cmds.Response) {
64
nd, err := req.InvocContext().GetNode()
@@ -119,8 +119,8 @@ EXAMPLE:
119
`,
120
},
121
Arguments: []cmds.Argument{
122
- cmds.StringArg("root", true, false, "the hash of the node to modify"),
123
- cmds.FileArg("data", true, false, "data fill with").EnableStdin(),
122
+ cmds.StringArg("root", true, false, "The hash of the node to modify."),
123
+ cmds.FileArg("data", true, false, "Data fill with.").EnableStdin(),
124
},
125
Run: func(req cmds.Request, res cmds.Response) {
126
nd, err := req.InvocContext().GetNode()
@@ -177,8 +177,8 @@ removes a link by the given name from root.
177
`,
178
},
179
Arguments: []cmds.Argument{
180
- cmds.StringArg("root", true, false, "the hash of the node to modify"),
181
- cmds.StringArg("link", true, false, "name of the link to remove"),
180
+ cmds.StringArg("root", true, false, "The hash of the node to modify."),
181
+ cmds.StringArg("link", true, false, "Name of the link to remove."),
182
},
183
Run: func(req cmds.Request, res cmds.Response) {
184
nd, err := req.InvocContext().GetNode()
@@ -246,12 +246,12 @@ a file containing 'bar', and returns the hash of the new object.
246
`,
247
},
248
Options: []cmds.Option{
249
- cmds.BoolOption("p", "create", "create intermediary nodes"),
249
+ cmds.BoolOption("p", "create", "Create intermediary nodes."),
250
},
251
Arguments: []cmds.Argument{
252
- cmds.StringArg("root", true, false, "the hash of the node to modify"),
253
- cmds.StringArg("name", true, false, "name of link to create"),
254
- cmds.StringArg("ref", true, false, "ipfs object to add link to"),
252
+ cmds.StringArg("root", true, false, "The hash of the node to modify."),
253
+ cmds.StringArg("name", true, false, "Name of link to create."),
254
+ cmds.StringArg("ref", true, false, "IPFS object to add link to."),
255
},
256
Run: func(req cmds.Request, res cmds.Response) {
257
nd, err := req.InvocContext().GetNode()
core/commands/pin.go
+8
-8
@@ -41,10 +41,10 @@ on disk.
41
},
42
43
Arguments: []cmds.Argument{
44
- cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be pinned").EnableStdin(),
44
+ cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be pinned.").EnableStdin(),
45
},
46
Options: []cmds.Option{
47
- cmds.BoolOption("recursive", "r", "Recursively pin the object linked to by the specified object(s)"),
47
+ cmds.BoolOption("recursive", "r", "Recursively pin the object linked to by the specified object(s)."),
48
},
49
Type: PinOutput{},
50
Run: func(req cmds.Request, res cmds.Response) {
@@ -109,10 +109,10 @@ collected if needed. (By default, recursively. Use -r=false for direct pins)
109
},
110
111
Arguments: []cmds.Argument{
112
- cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be unpinned").EnableStdin(),
112
+ cmds.StringArg("ipfs-path", true, true, "Path to object(s) to be unpinned.").EnableStdin(),
113
},
114
Options: []cmds.Option{
115
- cmds.BoolOption("recursive", "r", "Recursively unpin the object linked to by the specified object(s)"),
115
+ cmds.BoolOption("recursive", "r", "Recursively unpin the object linked to by the specified object(s)."),
116
},
117
Type: PinOutput{},
118
Run: func(req cmds.Request, res cmds.Response) {
@@ -194,12 +194,12 @@ Example:
194
},
195
196
Arguments: []cmds.Argument{
197
- cmds.StringArg("ipfs-path", false, true, "Path to object(s) to be listed"),
197
+ cmds.StringArg("ipfs-path", false, true, "Path to object(s) to be listed."),
198
},
199
Options: []cmds.Option{
200
- cmds.StringOption("type", "t", "The type of pinned keys to list. Can be \"direct\", \"indirect\", \"recursive\", or \"all\". Defaults to \"recursive\""),
201
- cmds.BoolOption("count", "n", "Show refcount when listing indirect pins"),
202
- cmds.BoolOption("quiet", "q", "Write just hashes of objects"),
200
+ cmds.StringOption("type", "t", "The type of pinned keys to list. Can be \"direct\", \"indirect\", \"recursive\", or \"all\". Defaults to \"recursive\"."),
201
+ cmds.BoolOption("count", "n", "Show refcount when listing indirect pins."),
202
+ cmds.BoolOption("quiet", "q", "Write just hashes of objects."),
203
},
204
Run: func(req cmds.Request, res cmds.Response) {
205
n, err := req.InvocContext().GetNode()
core/commands/ping.go
+2
-2
@@ -38,10 +38,10 @@ trip latency information.
38
`,
39
},
40
Arguments: []cmds.Argument{
41
- cmds.StringArg("peer ID", true, true, "ID of peer to be pinged").EnableStdin(),
41
+ cmds.StringArg("peer ID", true, true, "ID of peer to be pinged.").EnableStdin(),
42
},
43
Options: []cmds.Option{
44
- cmds.IntOption("count", "n", "number of ping messages to send"),
44
+ cmds.IntOption("count", "n", "Number of ping messages to send."),
45
},
46
Marshalers: cmds.MarshalerMap{
47
cmds.Text: func(res cmds.Response) (io.Reader, error) {
core/commands/publish.go
+4
-4
@@ -47,12 +47,12 @@ Publish an <ipfs-path> to another public key (not implemented):
47
},
48
49
Arguments: []cmds.Argument{
50
- cmds.StringArg("ipfs-path", true, false, "IPFS path of the obejct to be published").EnableStdin(),
50
+ cmds.StringArg("ipfs-path", true, false, "IPFS path of the obejct to be published.").EnableStdin(),
51
},
52
Options: []cmds.Option{
53
- cmds.BoolOption("resolve", "resolve given path before publishing (default=true)"),
54
- cmds.StringOption("lifetime", "t", "time duration that the record will be valid for (default: 24hrs)"),
55
- cmds.StringOption("ttl", "time duration this record should be cached for (caution: experimental)"),
53
+ cmds.BoolOption("resolve", "Resolve given path before publishing (default=true)."),
54
+ cmds.StringOption("lifetime", "t", "Time duration that the record will be valid for (default: 24hrs)."),
55
+ cmds.StringOption("ttl", "Time duration this record should be cached for (caution: experimental)."),
56
},
57
Run: func(req cmds.Request, res cmds.Response) {
58
log.Debug("Begin Publish")
core/commands/refs.go
+5
-5
@@ -47,13 +47,13 @@ Note: list all refs recursively with -r.
47
"local": RefsLocalCmd,
48
},
49
Arguments: []cmds.Argument{
50
- cmds.StringArg("ipfs-path", true, true, "Path to the object(s) to list refs from").EnableStdin(),
50
+ cmds.StringArg("ipfs-path", true, true, "Path to the object(s) to list refs from.").EnableStdin(),
51
},
52
Options: []cmds.Option{
53
- cmds.StringOption("format", "Emit edges with given format. tokens: <src> <dst> <linkname>"),
54
- cmds.BoolOption("edges", "e", "Emit edge format: `<from> -> <to>`"),
55
- cmds.BoolOption("unique", "u", "Omit duplicate refs from output"),
56
- cmds.BoolOption("recursive", "r", "Recursively list links of child nodes"),
53
+ cmds.StringOption("format", "Emit edges with given format. tokens: <src> <dst> <linkname>."),
54
+ cmds.BoolOption("edges", "e", "Emit edge format: `<from> -> <to>`."),
55
+ cmds.BoolOption("unique", "u", "Omit duplicate refs from output."),
56
+ cmds.BoolOption("recursive", "r", "Recursively list links of child nodes."),
57
},
58
Run: func(req cmds.Request, res cmds.Response) {
59
ctx := req.Context()
core/commands/repo.go
+1
-1
@@ -34,7 +34,7 @@ order to reclaim hard disk space.
34
},
35
36
Options: []cmds.Option{
37
- cmds.BoolOption("quiet", "q", "Write minimal output"),
37
+ cmds.BoolOption("quiet", "q", "Write minimal output."),
38
},
39
Run: func(req cmds.Request, res cmds.Response) {
40
n, err := req.InvocContext().GetNode()
core/commands/resolve.go
+1
-1
@@ -58,7 +58,7 @@ Resolve the value of an IPFS DAG path:
58
cmds.StringArg("name", true, false, "The name to resolve.").EnableStdin(),
59
},
60
Options: []cmds.Option{
61
- cmds.BoolOption("recursive", "r", "Resolve until the result is an IPFS name"),
61
+ cmds.BoolOption("recursive", "r", "Resolve until the result is an IPFS name."),
62
},
63
Run: func(req cmds.Request, res cmds.Response) {
64
core/commands/root.go
+5
-5
@@ -79,11 +79,11 @@ at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable
79
`,
80
},
81
Options: []cmds.Option{
82
- cmds.StringOption("config", "c", "Path to the configuration file to use"),
83
- cmds.BoolOption("debug", "D", "Operate in debug mode"),
84
- cmds.BoolOption("help", "Show the full command help text"),
85
- cmds.BoolOption("h", "Show a short version of the command help text"),
86
- cmds.BoolOption("local", "L", "Run the command locally, instead of using the daemon"),
82
+ cmds.StringOption("config", "c", "Path to the configuration file to use."),
83
+ cmds.BoolOption("debug", "D", "Operate in debug mode."),
84
+ cmds.BoolOption("help", "Show the full command help text."),
85
+ cmds.BoolOption("h", "Show a short version of the command help text."),
86
+ cmds.BoolOption("local", "L", "Run the command locally, instead of using the daemon."),
87
cmds.StringOption(ApiOption, "Use a specific API instance (defaults to /ip4/127.0.0.1/tcp/5001)"),
88
},
89
}
core/commands/stat.go
+4
-4
@@ -33,10 +33,10 @@ var statBwCmd = &cmds.Command{
33
ShortDescription: ``,
34
},
35
Options: []cmds.Option{
36
- cmds.StringOption("peer", "p", "specify a peer to print bandwidth for"),
37
- cmds.StringOption("proto", "t", "specify a protocol to print bandwidth for"),
38
- cmds.BoolOption("poll", "print bandwidth at an interval"),
39
- cmds.StringOption("interval", "i", "time interval to wait between updating output"),
36
+ cmds.StringOption("peer", "p", "Specify a peer to print bandwidth for."),
37
+ cmds.StringOption("proto", "t", "Specify a protocol to print bandwidth for."),
38
+ cmds.BoolOption("poll", "Print bandwidth at an interval."),
39
+ cmds.StringOption("interval", "i", "Time interval to wait between updating output."),
40
},
41
42
Run: func(req cmds.Request, res cmds.Response) {
core/commands/swarm.go
+5
-5
@@ -159,7 +159,7 @@ ipfs swarm addrs local lists all local addresses the node is listening on.
159
`,
160
},
161
Options: []cmds.Option{
162
- cmds.BoolOption("id", "Show peer ID in addresses"),
162
+ cmds.BoolOption("id", "Show peer ID in addresses."),
163
},
164
Run: func(req cmds.Request, res cmds.Response) {
165
@@ -207,7 +207,7 @@ ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3
207
`,
208
},
209
Arguments: []cmds.Argument{
210
- cmds.StringArg("address", true, true, "address of peer to connect to").EnableStdin(),
210
+ cmds.StringArg("address", true, true, "Address of peer to connect to.").EnableStdin(),
211
},
212
Run: func(req cmds.Request, res cmds.Response) {
213
ctx := req.Context()
@@ -262,7 +262,7 @@ ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQA
262
`,
263
},
264
Arguments: []cmds.Argument{
265
- cmds.StringArg("address", true, true, "address of peer to connect to").EnableStdin(),
265
+ cmds.StringArg("address", true, true, "Address of peer to connect to.").EnableStdin(),
266
},
267
Run: func(req cmds.Request, res cmds.Response) {
268
n, err := req.InvocContext().GetNode()
@@ -429,7 +429,7 @@ add your filters to the ipfs config file.
429
`,
430
},
431
Arguments: []cmds.Argument{
432
- cmds.StringArg("address", true, true, "multiaddr to filter").EnableStdin(),
432
+ cmds.StringArg("address", true, true, "Multiaddr to filter.").EnableStdin(),
433
},
434
Run: func(req cmds.Request, res cmds.Response) {
435
n, err := req.InvocContext().GetNode()
@@ -471,7 +471,7 @@ remove your filters from the ipfs config file.
471
`,
472
},
473
Arguments: []cmds.Argument{
474
- cmds.StringArg("address", true, true, "multiaddr filter to remove").EnableStdin(),
474
+ cmds.StringArg("address", true, true, "Multiaddr filter to remove.").EnableStdin(),
475
},
476
Run: func(req cmds.Request, res cmds.Response) {
477
n, err := req.InvocContext().GetNode()
core/commands/tar.go
+2
-2
@@ -31,7 +31,7 @@ var tarAddCmd = &cmds.Command{
31
},
32
33
Arguments: []cmds.Argument{
34
- cmds.FileArg("file", true, false, "tar file to add").EnableStdin(),
34
+ cmds.FileArg("file", true, false, "Tar file to add.").EnableStdin(),
35
},
36
Run: func(req cmds.Request, res cmds.Response) {
37
nd, err := req.InvocContext().GetNode()
@@ -82,7 +82,7 @@ var tarCatCmd = &cmds.Command{
82
},
83
84
Arguments: []cmds.Argument{
85
- cmds.StringArg("path", true, false, "ipfs path of archive to export").EnableStdin(),
85
+ cmds.StringArg("path", true, false, "Ipfs path of archive to export.").EnableStdin(),
86
},
87
Run: func(req cmds.Request, res cmds.Response) {
88
nd, err := req.InvocContext().GetNode()
core/commands/tour.go
+1
-1
@@ -25,7 +25,7 @@ IPFS very quickly. To start, run:
25
},
26
27
Arguments: []cmds.Argument{
28
- cmds.StringArg("id", false, false, "The id of the topic you would like to tour"),
28
+ cmds.StringArg("id", false, false, "The id of the topic you would like to tour."),
29
},
30
Subcommands: map[string]*cmds.Command{
31
"list": cmdIpfsTourList,
core/commands/unixfs/ls.go
+1
-1
@@ -46,7 +46,7 @@ size is the IPFS link size.
46
},
47
48
Arguments: []cmds.Argument{
49
- cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from").EnableStdin(),
49
+ cmds.StringArg("ipfs-path", true, true, "The path to the IPFS object(s) to list links from.").EnableStdin(),
50
},
51
Run: func(req cmds.Request, res cmds.Response) {
52
node, err := req.InvocContext().GetNode()
core/commands/version.go
+3
-3
@@ -23,9 +23,9 @@ var VersionCmd = &cmds.Command{
23
},
24
25
Options: []cmds.Option{
26
- cmds.BoolOption("number", "n", "Only show the version number"),
27
- cmds.BoolOption("commit", "Show the commit hash"),
28
- cmds.BoolOption("repo", "Show repo version"),
26
+ cmds.BoolOption("number", "n", "Only show the version number."),
27
+ cmds.BoolOption("commit", "Show the commit hash."),
28
+ cmds.BoolOption("repo", "Show repo version."),
29
},
30
Run: func(req cmds.Request, res cmds.Response) {
31
res.SetOutput(&VersionOutput{