Make all Taglines use imperative mood
License: MIT Signed-off-by: Jesse Weinstein <jesse@wefu.org>
Jesse Weinstein committed
Aug 4, 2016 at 16:45 UTC
1d6a47bf939f85aa90517ece2436a0673ce523d0
21 files changed
+32
-32
core/commands/bitswap.go
+1
-1
@@ -16,7 +16,7 @@ import (
16
17
var BitswapCmd = &cmds.Command{
18
Helptext: cmds.HelpText{
19
- Tagline: "A set of commands to manipulate the bitswap agent.",
19
+ Tagline: "Interact with the bitswap agent.",
20
ShortDescription: ``,
21
},
22
Subcommands: map[string]*cmds.Command{
core/commands/block.go
+2
-2
@@ -26,7 +26,7 @@ func (bs BlockStat) String() string {
26
27
var BlockCmd = &cmds.Command{
28
Helptext: cmds.HelpText{
29
- Tagline: "Manipulate raw IPFS blocks.",
29
+ Tagline: "Interact with raw IPFS blocks.",
30
ShortDescription: `
31
'ipfs block' is a plumbing command used to manipulate raw ipfs blocks.
32
Reads from stdin or writes to stdout, and <key> is a base58 encoded
@@ -103,7 +103,7 @@ It outputs to stdout, and <key> is a base58 encoded multihash.
103
104
var blockPutCmd = &cmds.Command{
105
Helptext: cmds.HelpText{
106
- Tagline: "Stores input as an IPFS block.",
106
+ Tagline: "Store input as an IPFS block.",
107
ShortDescription: `
108
'ipfs block put' is a plumbing command for storing raw ipfs blocks.
109
It reads from stdin, and <key> is a base58 encoded multihash.
core/commands/bootstrap.go
+2
-2
@@ -181,7 +181,7 @@ in the bootstrap list).`,
181
182
var bootstrapRemoveCmd = &cmds.Command{
183
Helptext: cmds.HelpText{
184
- Tagline: "Removes peers from the bootstrap list.",
184
+ Tagline: "Remove peers from the bootstrap list.",
185
ShortDescription: `Outputs the list of peers that were removed.
186
` + bootstrapSecurityWarning,
187
},
@@ -250,7 +250,7 @@ var bootstrapRemoveCmd = &cmds.Command{
250
251
var bootstrapRemoveAllCmd = &cmds.Command{
252
Helptext: cmds.HelpText{
253
- Tagline: "Removes all peers from the bootstrap list.",
253
+ Tagline: "Remove all peers from the bootstrap list.",
254
ShortDescription: `Outputs the list of peers that were removed.`,
255
},
256
core/commands/config.go
+3
-3
@@ -135,7 +135,7 @@ Set the value of the 'datastore.path' key:
135
136
var configShowCmd = &cmds.Command{
137
Helptext: cmds.HelpText{
138
- Tagline: "Outputs the content of the config file.",
138
+ Tagline: "Output config file contents.",
139
ShortDescription: `
140
WARNING: Your private key is stored in the config file, and it will be
141
included in the output of this command.
@@ -182,7 +182,7 @@ included in the output of this command.
182
183
var configEditCmd = &cmds.Command{
184
Helptext: cmds.HelpText{
185
- Tagline: "Opens the config file for editing in $EDITOR.",
185
+ Tagline: "Open the config file for editing in $EDITOR.",
186
ShortDescription: `
187
To use 'ipfs config edit', you must have the $EDITOR environment
188
variable set to your preferred text editor.
@@ -205,7 +205,7 @@ variable set to your preferred text editor.
205
206
var configReplaceCmd = &cmds.Command{
207
Helptext: cmds.HelpText{
208
- Tagline: "Replaces the config with <file>.",
208
+ Tagline: "Replace the config with <file>.",
209
ShortDescription: `
210
Make sure to back up the config file first if neccessary, as this operation
211
can't be undone.
core/commands/diag.go
+2
-2
@@ -42,7 +42,7 @@ var DefaultDiagnosticTimeout = time.Second * 20
42
43
var DiagCmd = &cmds.Command{
44
Helptext: cmds.HelpText{
45
- Tagline: "Generates diagnostic reports.",
45
+ Tagline: "Generate diagnostic reports.",
46
},
47
48
Subcommands: map[string]*cmds.Command{
@@ -54,7 +54,7 @@ var DiagCmd = &cmds.Command{
54
55
var diagNetCmd = &cmds.Command{
56
Helptext: cmds.HelpText{
57
- Tagline: "Generates a network diagnostics report.",
57
+ Tagline: "Generate a network diagnostics report.",
58
ShortDescription: `
59
Sends out a message to each node in the network recursively
60
requesting a listing of data about them including number of
core/commands/dns.go
+1
-1
@@ -11,7 +11,7 @@ import (
11
12
var DNSCmd = &cmds.Command{
13
Helptext: cmds.HelpText{
14
- Tagline: "DNS link resolver.",
14
+ Tagline: "Resolve DNS links.",
15
ShortDescription: `
16
Multihashes are hard to remember, but domain names are usually easy to
17
remember. To create memorable aliases for multihashes, DNS TXT
core/commands/files/files.go
+1
-1
@@ -24,7 +24,7 @@ var log = logging.Logger("cmds/files")
24
25
var FilesCmd = &cmds.Command{
26
Helptext: cmds.HelpText{
27
- Tagline: "Manipulate unixfs files.",
27
+ Tagline: "Interact with unixfs files.",
28
ShortDescription: `
29
Files is an API for manipulating IPFS objects as if they were a unix
30
filesystem.
core/commands/ipns.go
+1
-1
@@ -13,7 +13,7 @@ import (
13
14
var IpnsCmd = &cmds.Command{
15
Helptext: cmds.HelpText{
16
- Tagline: "Gets the value currently published at an IPNS name.",
16
+ Tagline: "Get the value currently published at an IPNS name.",
17
ShortDescription: `
18
IPNS is a PKI namespace, where names are the hashes of public keys, and
19
the private key enables publishing new (signed) values. In resolve, the
core/commands/mount_nofuse.go
+1
-1
@@ -9,7 +9,7 @@ import (
9
10
var MountCmd = &cmds.Command{
11
Helptext: cmds.HelpText{
12
- Tagline: "Mounts IPFS to the filesystem (disabled).",
12
+ Tagline: "Mount IPFS to the filesystem (disabled).",
13
ShortDescription: `
14
This version of ipfs is compiled without fuse support, which is required
15
for mounting. If you'd like to be able to mount, please use a version of
core/commands/mount_unix.go
+1
-1
@@ -15,7 +15,7 @@ import (
15
16
var MountCmd = &cmds.Command{
17
Helptext: cmds.HelpText{
18
- Tagline: "Mounts IPFS to the filesystem (read-only).",
18
+ Tagline: "Mount IPFS to the filesystem (read-only).",
19
ShortDescription: `
20
Mount ipfs at a read-only mountpoint on the OS (default: /ipfs and /ipns).
21
All ipfs objects will be accessible under that directory. Note that the
core/commands/name.go
+1
-1
@@ -9,7 +9,7 @@ type IpnsEntry struct {
9
10
var NameCmd = &cmds.Command{
11
Helptext: cmds.HelpText{
12
- Tagline: "IPFS namespace (IPNS) tool.",
12
+ Tagline: "Interact with the IPFS namespace (IPNS).",
13
ShortDescription: `
14
IPNS is a PKI namespace, where names are the hashes of public keys, and
15
the private key enables publishing new (signed) values. In both publish
core/commands/object/diff.go
+1
-1
@@ -17,7 +17,7 @@ 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: "Display the diff between two ipfs objects.",
21
ShortDescription: `
22
'ipfs object diff' is a command used to show the differences between
23
two ipfs objects.`,
core/commands/object/object.go
+4
-4
@@ -63,7 +63,7 @@ directly.`,
63
64
var ObjectDataCmd = &cmds.Command{
65
Helptext: cmds.HelpText{
66
- Tagline: "Outputs the raw bytes in an IPFS object.",
66
+ Tagline: "Output the raw bytes of an IPFS object.",
67
ShortDescription: `
68
'ipfs object data' is a plumbing command for retrieving the raw bytes stored
69
in a DAG node. It outputs to stdout, and <key> is a base58 encoded multihash.
@@ -99,7 +99,7 @@ is the raw data of the object.
99
100
var ObjectLinksCmd = &cmds.Command{
101
Helptext: cmds.HelpText{
102
- Tagline: "Outputs the links pointed to by the specified object.",
102
+ Tagline: "Output the links pointed to by the specified object.",
103
ShortDescription: `
104
'ipfs object links' is a plumbing command for retrieving the links from
105
a DAG node. It outputs to stdout, and <key> is a base58 encoded
@@ -293,7 +293,7 @@ var ObjectStatCmd = &cmds.Command{
293
294
var ObjectPutCmd = &cmds.Command{
295
Helptext: cmds.HelpText{
296
- Tagline: "Stores input as a DAG object, outputs its key.",
296
+ Tagline: "Store input as a DAG object, print its key.",
297
ShortDescription: `
298
'ipfs object put' is a plumbing command for storing DAG nodes.
299
It reads from stdin, and the output is a base58 encoded multihash.
@@ -384,7 +384,7 @@ And then run:
384
385
var ObjectNewCmd = &cmds.Command{
386
Helptext: cmds.HelpText{
387
- Tagline: "Creates a new object from an ipfs template.",
387
+ Tagline: "Create a new object from an ipfs template.",
388
ShortDescription: `
389
'ipfs object new' is a plumbing command for creating new DAG nodes.
390
`,
core/commands/pin.go
+2
-2
@@ -34,7 +34,7 @@ type PinOutput struct {
34
35
var addPinCmd = &cmds.Command{
36
Helptext: cmds.HelpText{
37
- Tagline: "Pins objects to local storage.",
37
+ Tagline: "Pin objects to local storage.",
38
ShortDescription: "Stores an IPFS object(s) from a given path locally to disk.",
39
},
40
@@ -95,7 +95,7 @@ var addPinCmd = &cmds.Command{
95
96
var rmPinCmd = &cmds.Command{
97
Helptext: cmds.HelpText{
98
- Tagline: "Removes the pinned object from local storage.",
98
+ Tagline: "Remove pinned objects from local storage.",
99
ShortDescription: `
100
Removes the pin from the given object allowing it to be garbage
101
collected if needed. (By default, recursively. Use -r=false for direct pins)
core/commands/refs.go
+2
-2
@@ -32,7 +32,7 @@ func KeyListTextMarshaler(res cmds.Response) (io.Reader, error) {
32
33
var RefsCmd = &cmds.Command{
34
Helptext: cmds.HelpText{
35
- Tagline: "Lists links (references) from an object.",
35
+ Tagline: "List links (references) from an object.",
36
ShortDescription: `
37
Lists the hashes of all the links an IPFS or IPNS object(s) contains,
38
with the following format:
@@ -130,7 +130,7 @@ NOTE: List all references recursively by using the flag '-r'.
130
131
var RefsLocalCmd = &cmds.Command{
132
Helptext: cmds.HelpText{
133
- Tagline: "Lists all local references.",
133
+ Tagline: "List all local references.",
134
ShortDescription: `
135
Displays the hashes of all local objects.
136
`,
core/commands/repo.go
+2
-2
@@ -24,7 +24,7 @@ type RepoVersion struct {
24
25
var RepoCmd = &cmds.Command{
26
Helptext: cmds.HelpText{
27
- Tagline: "Manipulate the IPFS repo.",
27
+ Tagline: "Interact with the IPFS repo.",
28
ShortDescription: `
29
'ipfs repo' is a plumbing command used to manipulate the repo.
30
`,
@@ -172,7 +172,7 @@ Version string The repo version.
172
173
var RepoFsckCmd = &cmds.Command{
174
Helptext: cmds.HelpText{
175
- Tagline: "Removes repo lockfiles.",
175
+ Tagline: "Remove repo lockfiles.",
176
ShortDescription: `
177
'ipfs repo fsck' is a plumbing command that will remove repo and level db
178
lockfiles, as well as the api file. This command can only run when no ipfs
core/commands/swarm.go
+1
-1
@@ -30,7 +30,7 @@ type addrMap struct {
30
31
var SwarmCmd = &cmds.Command{
32
Helptext: cmds.HelpText{
33
- Tagline: "Swarm inspection tool.",
33
+ Tagline: "Interact with the swarm.",
34
ShortDescription: `
35
'ipfs swarm' is a tool to manipulate the network swarm. The swarm is the
36
component that opens, listens for, and maintains connections to other
core/commands/sysdiag.go
+1
-1
@@ -14,7 +14,7 @@ import (
14
15
var sysDiagCmd = &cmds.Command{
16
Helptext: cmds.HelpText{
17
- Tagline: "Prints out system diagnostic information.",
17
+ Tagline: "Print system diagnostic information.",
18
ShortDescription: `
19
Prints out information about your computer to aid in easier debugging.
20
`,
core/commands/tar.go
+1
-1
@@ -13,7 +13,7 @@ import (
13
14
var TarCmd = &cmds.Command{
15
Helptext: cmds.HelpText{
16
- Tagline: "Utility functions for tar files in IPFS.",
16
+ Tagline: "Interact with tar files in IPFS.",
17
},
18
19
Subcommands: map[string]*cmds.Command{
core/commands/tour.go
+1
-1
@@ -14,7 +14,7 @@ import (
14
15
var tourCmd = &cmds.Command{
16
Helptext: cmds.HelpText{
17
- Tagline: "An introduction to IPFS.",
17
+ Tagline: "Provide an introduction to IPFS.",
18
ShortDescription: `
19
This is a tour that takes you through various IPFS concepts,
20
features, and tools to make sure you get up to speed with
core/commands/version.go
+1
-1
@@ -21,7 +21,7 @@ type VersionOutput struct {
21
22
var VersionCmd = &cmds.Command{
23
Helptext: cmds.HelpText{
24
- Tagline: "Shows ipfs version information.",
24
+ Tagline: "Show ipfs version information.",
25
ShortDescription: "Returns the current version of ipfs and exits.",
26
},
27