Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit cc70771

Browse files
RichardLittRichardLitt
committedJan 24, 2016
Capitalized beginning of line messages, added periods
License: MIT Signed-off-by: Richard Littauer <richard.littauer@gmail.com>
1 parent a5c4c5d commit cc70771

32 files changed

+121
-121
lines changed
 

‎cmd/ipfs/init.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -35,13 +35,13 @@ at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable
3535

3636
Options: []cmds.Option{
3737
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."),
4040

4141
// TODO need to decide whether to expose the override as a file or a
4242
// directory. That is: should we allow the user to also specify the
4343
// 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."),
4545
},
4646
PreRun: func(req cmds.Request) error {
4747
daemonLocked, err := fsrepo.LockedByOtherProcess(req.InvocContext().ConfigRoot)

‎core/commands/add.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ MerkleDAG.
3939
},
4040

4141
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(),
4343
},
4444
Options: []cmds.Option{
4545
cmds.OptionRecursivePath, // a builtin option that allows recursive paths (-r, --recursive)

‎core/commands/block.go

+3-3
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ on raw ipfs blocks. It outputs the following to stdout:
5555
},
5656

5757
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(),
5959
},
6060
Run: func(req cmds.Request, res cmds.Response) {
6161
b, err := getBlockForKey(req, req.Arguments()[0])
@@ -88,7 +88,7 @@ It outputs to stdout, and <key> is a base58 encoded multihash.
8888
},
8989

9090
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(),
9292
},
9393
Run: func(req cmds.Request, res cmds.Response) {
9494
b, err := getBlockForKey(req, req.Arguments()[0])
@@ -111,7 +111,7 @@ It reads from stdin, and <key> is a base58 encoded multihash.
111111
},
112112

113113
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(),
115115
},
116116
Run: func(req cmds.Request, res cmds.Response) {
117117
n, err := req.InvocContext().GetNode()

‎core/commands/bootstrap.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ in the bootstrap list).
5656
},
5757

5858
Options: []cmds.Option{
59-
cmds.BoolOption("default", "add default bootstrap nodes"),
59+
cmds.BoolOption("default", "Add default bootstrap nodes."),
6060
},
6161

6262
Run: func(req cmds.Request, res cmds.Response) {

‎core/commands/cat.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ it contains.
2323
},
2424

2525
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(),
2727
},
2828
Run: func(req cmds.Request, res cmds.Response) {
2929
node, err := req.InvocContext().GetNode()

‎core/commands/config.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -54,12 +54,12 @@ Set the value of the 'datastore.path' key:
5454
},
5555

5656
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."),
5959
},
6060
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."),
6363
},
6464
Run: func(req cmds.Request, res cmds.Response) {
6565
args := req.Arguments()
@@ -189,7 +189,7 @@ can't be undone.
189189
},
190190

191191
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."),
193193
},
194194
Run: func(req cmds.Request, res cmds.Response) {
195195
r, err := fsrepo.Open(req.InvocContext().ConfigRoot)

‎core/commands/dht.go

+10-10
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,10 @@ var queryDhtCmd = &cmds.Command{
4040
},
4141

4242
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."),
4444
},
4545
Options: []cmds.Option{
46-
cmds.BoolOption("verbose", "v", "Write extra information"),
46+
cmds.BoolOption("verbose", "v", "Write extra information."),
4747
},
4848
Run: func(req cmds.Request, res cmds.Response) {
4949
n, err := req.InvocContext().GetNode()
@@ -126,10 +126,10 @@ FindProviders will return a list of peers who are able to provide the value requ
126126
},
127127

128128
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."),
130130
},
131131
Options: []cmds.Option{
132-
cmds.BoolOption("verbose", "v", "Write extra information"),
132+
cmds.BoolOption("verbose", "v", "Write extra information."),
133133
},
134134
Run: func(req cmds.Request, res cmds.Response) {
135135
n, err := req.InvocContext().GetNode()
@@ -227,7 +227,7 @@ var findPeerDhtCmd = &cmds.Command{
227227
},
228228

229229
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."),
231231
},
232232
Run: func(req cmds.Request, res cmds.Response) {
233233
n, err := req.InvocContext().GetNode()
@@ -324,10 +324,10 @@ GetValue will return the value stored in the dht at the given key.
324324
},
325325

326326
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."),
328328
},
329329
Options: []cmds.Option{
330-
cmds.BoolOption("verbose", "v", "Write extra information"),
330+
cmds.BoolOption("verbose", "v", "Write extra information."),
331331
},
332332
Run: func(req cmds.Request, res cmds.Response) {
333333
n, err := req.InvocContext().GetNode()
@@ -427,11 +427,11 @@ PutValue will store the given key value pair in the dht.
427427
},
428428

429429
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(),
432432
},
433433
Options: []cmds.Option{
434-
cmds.BoolOption("verbose", "v", "Write extra information"),
434+
cmds.BoolOption("verbose", "v", "Write extra information."),
435435
},
436436
Run: func(req cmds.Request, res cmds.Response) {
437437
n, err := req.InvocContext().GetNode()

‎core/commands/diag.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ that consume the dot format to generate graphs of the network.
8686
},
8787

8888
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, ", ")),
9090
},
9191

9292
Run: func(req cmds.Request, res cmds.Response) {

‎core/commands/dns.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ The resolver will give:
5050
cmds.StringArg("domain-name", true, false, "The domain-name name to resolve.").EnableStdin(),
5151
},
5252
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."),
5454
},
5555
Run: func(req cmds.Request, res cmds.Response) {
5656

‎core/commands/external.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ import (
1414
func ExternalBinary() *cmds.Command {
1515
return &cmds.Command{
1616
Arguments: []cmds.Argument{
17-
cmds.StringArg("args", false, true, "arguments for subcommand"),
17+
cmds.StringArg("args", false, true, "Arguments for subcommand."),
1818
},
1919
External: true,
2020
Run: func(req cmds.Request, res cmds.Response) {

‎core/commands/files/files.go

+21-21
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Files is an API for manipulating ipfs objects as if they were a unix filesystem.
3030
`,
3131
},
3232
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)."),
3434
},
3535
Subcommands: map[string]*cmds.Command{
3636
"read": FilesReadCmd,
@@ -50,7 +50,7 @@ var FilesStatCmd = &cmds.Command{
5050
},
5151

5252
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."),
5454
},
5555
Run: func(req cmds.Request, res cmds.Response) {
5656
node, err := req.InvocContext().GetNode()
@@ -140,8 +140,8 @@ var FilesCpCmd = &cmds.Command{
140140
Tagline: "Copy files into mfs.",
141141
},
142142
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."),
145145
},
146146
Run: func(req cmds.Request, res cmds.Response) {
147147
node, err := req.InvocContext().GetNode()
@@ -228,10 +228,10 @@ Examples:
228228
`,
229229
},
230230
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."),
232232
},
233233
Options: []cmds.Option{
234-
cmds.BoolOption("l", "use long listing format"),
234+
cmds.BoolOption("l", "Use long listing format."),
235235
},
236236
Run: func(req cmds.Request, res cmds.Response) {
237237
path, err := checkPath(req.Arguments()[0])
@@ -323,11 +323,11 @@ Examples:
323323
},
324324

325325
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."),
327327
},
328328
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."),
331331
},
332332
Run: func(req cmds.Request, res cmds.Response) {
333333
n, err := req.InvocContext().GetNode()
@@ -412,8 +412,8 @@ Example:
412412
},
413413

414414
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."),
417417
},
418418
Run: func(req cmds.Request, res cmds.Response) {
419419
n, err := req.InvocContext().GetNode()
@@ -468,14 +468,14 @@ Warning:
468468
`,
469469
},
470470
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(),
473473
},
474474
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."),
479479
},
480480
Run: func(req cmds.Request, res cmds.Response) {
481481
path, err := checkPath(req.Arguments()[0])
@@ -580,10 +580,10 @@ Examples:
580580
},
581581

582582
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."),
584584
},
585585
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."),
587587
},
588588
Run: func(req cmds.Request, res cmds.Response) {
589589
n, err := req.InvocContext().GetNode()
@@ -629,10 +629,10 @@ remove files or directories
629629
},
630630

631631
Arguments: []cmds.Argument{
632-
cmds.StringArg("path", true, true, "file to remove"),
632+
cmds.StringArg("path", true, true, "File to remove."),
633633
},
634634
Options: []cmds.Option{
635-
cmds.BoolOption("r", "recursive", "recursively remove directories"),
635+
cmds.BoolOption("r", "recursive", "Recursively remove directories."),
636636
},
637637
Run: func(req cmds.Request, res cmds.Response) {
638638
nd, err := req.InvocContext().GetNode()

‎core/commands/get.go

+5-5
Original file line numberDiff line numberDiff line change
@@ -37,13 +37,13 @@ may also specify the level of compression by specifying '-l=<1-9>'.
3737
},
3838

3939
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(),
4141
},
4242
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)."),
4747
},
4848
PreRun: func(req cmds.Request) error {
4949
_, err := getCompressOptions(req)

‎core/commands/id.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,10 @@ ipfs id supports the format option for output with the following keys:
5050
`,
5151
},
5252
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(),
5454
},
5555
Options: []cmds.Option{
56-
cmds.StringOption("format", "f", "optional output format"),
56+
cmds.StringOption("format", "f", "Optional output format."),
5757
},
5858
Run: func(req cmds.Request, res cmds.Response) {
5959
node, err := req.InvocContext().GetNode()

‎core/commands/ipns.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ Resolve the value of another name:
4444
cmds.StringArg("name", false, false, "The IPNS name to resolve. Defaults to your node's peerID.").EnableStdin(),
4545
},
4646
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."),
4949
},
5050
Run: func(req cmds.Request, res cmds.Response) {
5151

‎core/commands/log.go

+1-1
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ output of a running daemon.
4242
// TODO use a different keyword for 'all' because all can theoretically
4343
// clash with a subsystem name
4444
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."),
4646
},
4747
Run: func(req cmds.Request, res cmds.Response) {
4848

‎core/commands/ls.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -41,10 +41,10 @@ it contains, with the following format:
4141
},
4242

4343
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(),
4545
},
4646
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)."),
4848
},
4949
Run: func(req cmds.Request, res cmds.Response) {
5050
node, err := req.InvocContext().GetNode()

‎core/commands/mount_unix.go

+2-2
Original file line numberDiff line numberDiff line change
@@ -93,8 +93,8 @@ baz
9393
`,
9494
},
9595
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."),
9898
},
9999
Run: func(req cmds.Request, res cmds.Response) {
100100
cfg, err := req.InvocContext().GetConfig()

0 commit comments

Comments
 (0)
Please sign in to comment.