Skip to content

Commit 51972ec

Browse files
author
devedge
committed
wrap-desc: Wrap help descriptions under 80 chars
Make all help command descriptions wrap under 80 characters, as per issue ipfs#2783 License: MIT Signed-off-by: Richard Pajerski <[email protected]>
1 parent 3b60666 commit 51972ec

File tree

13 files changed

+62
-35
lines changed

13 files changed

+62
-35
lines changed

‎cmd/ipfs/daemon.go

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,8 @@ do this by setting headers on the API.HTTPHeaders and Gateway.HTTPHeaders
9292
keys:
9393
9494
ipfs config --json API.HTTPHeaders.X-Special-Header '["so special :)"]'
95-
ipfs config --json Gateway.HTTPHeaders.X-Special-Header '["so special :)"]'
95+
ipfs config --json Gateway.HTTPHeaders.X-Special-Header '["so special
96+
:)"]'
9697
9798
Note that the value of the keys is an _array_ of strings. This is because
9899
headers can have more than one value, and it is convenient to pass through
@@ -102,9 +103,12 @@ CORS Headers (for API)
102103
103104
You can setup CORS headers the same way:
104105
105-
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin '["example.com"]'
106-
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT", "GET", "POST"]'
107-
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials '["true"]'
106+
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Origin
107+
'["example.com"]'
108+
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Methods '["PUT",
109+
"GET", "POST"]'
110+
ipfs config --json API.HTTPHeaders.Access-Control-Allow-Credentials
111+
'["true"]'
108112
109113
Shutdown
110114
@@ -124,8 +128,8 @@ environment variable:
124128
Routing
125129
126130
IPFS by default will use a DHT for content routing. There is a highly
127-
experimental alternative that operates the DHT in a 'client only' mode that can
128-
be enabled by running the daemon as:
131+
experimental alternative that operates the DHT in a 'client only' mode that
132+
can be enabled by running the daemon as:
129133
130134
ipfs daemon --routing=dhtclient
131135

‎core/commands/dag/dag.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,8 @@ var DagGetCmd = &cmds.Command{
128128
Helptext: cmds.HelpText{
129129
Tagline: "Get a dag node from ipfs.",
130130
ShortDescription: `
131-
'ipfs dag get' fetches a dag node from ipfs and prints it out in the specifed format.
131+
'ipfs dag get' fetches a dag node from ipfs and prints it out in the specifed
132+
format.
132133
`,
133134
},
134135
Arguments: []cmds.Argument{

‎core/commands/files/files.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -557,7 +557,8 @@ var FilesWriteCmd = &cmds.Command{
557557
Tagline: "Write to a mutable file in a given filesystem.",
558558
ShortDescription: `
559559
Write data to a file in a given filesystem. This command allows you to specify
560-
a beginning offset to write to. The entire length of the input will be written.
560+
a beginning offset to write to. The entire length of the input will be
561+
written.
561562
562563
If the '--create' option is specified, the file will be created if it does not
563564
exist. Nonexistant intermediate directories will not be created.

‎core/commands/ipns.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ the private key enables publishing new (signed) values. In both publish
2626
and resolve, the default name used is the node's own PeerID,
2727
which is the hash of its public key.
2828
29-
You can use the 'ipfs key' commands to list and generate more names and their respective keys.
29+
You can use the 'ipfs key' commands to list and generate more names and their
30+
respective keys.
3031
3132
Examples:
3233

‎core/commands/keystore.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,8 @@ var KeyCmd = &cmds.Command{
2020
Helptext: cmds.HelpText{
2121
Tagline: "Create and list IPNS name keypairs",
2222
ShortDescription: `
23-
'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name publish'.
23+
'ipfs key gen' generates a new keypair for usage with IPNS and 'ipfs name
24+
publish'.
2425
2526
> ipfs key gen --type=rsa --size=2048 mykey
2627
> ipfs name publish --key=mykey QmSomeHash

‎core/commands/log.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,8 @@ var logLevelCmd = &cmds.Command{
3535
Helptext: cmds.HelpText{
3636
Tagline: "Change the logging level.",
3737
ShortDescription: `
38-
Change the verbosity of one or all subsystems log output. This does not affect the event log.
38+
Change the verbosity of one or all subsystems log output. This does not affect
39+
the event log.
3940
`,
4041
},
4142

‎core/commands/name.go

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,24 @@ the private key enables publishing new (signed) values. In both publish
2222
and resolve, the default name used is the node's own PeerID,
2323
which is the hash of its public key.
2424
25-
You can use the 'ipfs key' commands to list and generate more names and their respective keys.
25+
You can use the 'ipfs key' commands to list and generate more names and their
26+
respective keys.
2627
2728
Examples:
2829
2930
Publish an <ipfs-path> with your default name:
3031
3132
> ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
32-
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
33+
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n:
34+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
3335
3436
Publish an <ipfs-path> with another name, added by an 'ipfs key' command:
3537
3638
> ipfs key gen --type=rsa --size=2048 mykey
37-
> ipfs name publish --key=mykey /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
38-
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
39+
> ipfs name publish --key=mykey
40+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
41+
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n:
42+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
3943
4044
Resolve the value of your name:
4145

‎core/commands/object/diff.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,8 @@ Example:
3939
Added QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD foo
4040
> OBJ_B=QmcmRptkSPWhptCttgHg27QNDmnV33wAJyUkCnAvqD3eCD
4141
> ipfs object diff -v $OBJ_A $OBJ_B
42-
Changed "bar" from QmNgd5cz2jNftnAHBhcRUGdtiaMzb5Rhjqd4etondHHST8 to QmRfFVsjSXkhFxrfWnLpMae2M4GBVsry6VAuYYcji5MiZb.
42+
Changed "bar" from QmNgd5cz2jNftnAHBhcRUGdtiaMzb5Rhjqd4etondHHST8 to
43+
QmRfFVsjSXkhFxrfWnLpMae2M4GBVsry6VAuYYcji5MiZb.
4344
`,
4445
},
4546
Arguments: []cmds.Argument{

‎core/commands/p2p.go

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,8 @@ var P2PCmd = &cmds.Command{
4747
ShortDescription: `
4848
Create and use tunnels to remote peers over libp2p
4949
50-
Note: this command is experimental and subject to change as usecases and APIs are refined`,
50+
Note: this command is experimental and subject to change as usecases and APIs
51+
are refined`,
5152
},
5253

5354
Subcommands: map[string]*cmds.Command{
@@ -188,7 +189,8 @@ var p2pListenerListenCmd = &cmds.Command{
188189
Helptext: cmds.HelpText{
189190
Tagline: "Forward p2p connections to a network multiaddr.",
190191
ShortDescription: `
191-
Register a p2p connection handler and forward the connections to a specified address.
192+
Register a p2p connection handler and forward the connections to a specified
193+
address.
192194
193195
Note that the connections originate from the ipfs daemon process.
194196
`,
@@ -237,9 +239,9 @@ var p2pStreamDialCmd = &cmds.Command{
237239
ShortDescription: `
238240
Establish a new connection to a peer service.
239241
240-
When a connection is made to a peer service the ipfs daemon will setup one time
241-
TCP listener and return it's bind port, this way a dialing application can
242-
transparently connect to a p2p service.
242+
When a connection is made to a peer service the ipfs daemon will setup one
243+
time TCP listener and return it's bind port, this way a dialing application
244+
can transparently connect to a p2p service.
243245
`,
244246
},
245247
Arguments: []cmds.Argument{

‎core/commands/publish.go

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,25 +34,32 @@ the private key enables publishing new (signed) values. In both publish
3434
and resolve, the default name used is the node's own PeerID,
3535
which is the hash of its public key.
3636
37-
You can use the 'ipfs key' commands to list and generate more names and their respective keys.
37+
You can use the 'ipfs key' commands to list and generate more names and their
38+
respective keys.
3839
3940
Examples:
4041
4142
Publish an <ipfs-path> with your default name:
4243
4344
> ipfs name publish /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
44-
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
45+
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n:
46+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
4547
4648
Publish an <ipfs-path> with another name, added by an 'ipfs key' command:
4749
4850
> ipfs key gen --type=rsa --size=2048 mykey
49-
> ipfs name publish --key=mykey /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
50-
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
51-
52-
Alternatively, publish an <ipfs-path> using a valid PeerID(as listed by 'ipfs key list -l'):
53-
54-
> ipfs name publish --key=QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
55-
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n: /ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
51+
> ipfs name publish --key=mykey
52+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
53+
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n:
54+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
55+
56+
Alternatively, publish an <ipfs-path> using a valid PeerID(as listed by 'ipfs
57+
key list -l'):
58+
59+
> ipfs name publish --key=QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n
60+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
61+
Published to QmbCMUZw6JFeZ7Wp9jkzbye3Fzp2GGcPgC3nmeUjfVF87n:
62+
/ipfs/QmatmE9msSfkKxoffpHwNLNKgwZG8eT9Bud6YoPab52vpy
5663
5764
`,
5865
},

‎core/commands/resolve.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,8 @@ Resolve the value of another name recursively:
4949
5050
Resolve the value of an IPFS DAG path:
5151
52-
$ ipfs resolve /ipfs/QmeZy1fGbwgVSrqbfh9fKQrAWgeyRnj7h8fsHS1oy3k99x/beep/boop
52+
$ ipfs resolve
53+
/ipfs/QmeZy1fGbwgVSrqbfh9fKQrAWgeyRnj7h8fsHS1oy3k99x/beep/boop
5354
/ipfs/QmYRMjyvAiHKN9UTi8Bzt1HUspmSRD8T8DwxfSMzLgBon1
5455
5556
`,

‎core/commands/root.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -66,8 +66,9 @@ TOOL COMMANDS
6666
6767
Use 'ipfs <command> --help' to learn more about each command.
6868
69-
ipfs uses a repository in the local file system. By default, the repo is located
70-
at ~/.ipfs. To change the repo location, set the $IPFS_PATH environment variable:
69+
ipfs uses a repository in the local file system. By default, the repo is
70+
located at ~/.ipfs. To change the repo location, set the $IPFS_PATH
71+
environment variable:
7172
7273
export IPFS_PATH=/path/to/ipfsrepo
7374

‎core/commands/swarm.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -304,7 +304,8 @@ var swarmConnectCmd = &cmds.Command{
304304
305305
The address format is an IPFS multiaddr:
306306
307-
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
307+
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAw
308+
e3N8SzbUtfsmvsqQLuvuJ
308309
`,
309310
},
310311
Arguments: []cmds.Argument{
@@ -369,7 +370,8 @@ var swarmDisconnectCmd = &cmds.Command{
369370
'ipfs swarm disconnect' closes a connection to a peer address. The address
370371
format is an IPFS multiaddr:
371372
372-
ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
373+
ipfs swarm disconnect /ip4/104.131.131.82/tcp/4001/ipfs/QmaCpDMGvV2BGHeYERUEnR
374+
QAwe3N8SzbUtfsmvsqQLuvuJ
373375
374376
The disconnect is not permanent; if ipfs needs to talk to that address later,
375377
it will reconnect.

0 commit comments

Comments
 (0)