docs(commands): explain that swarm connect can reuse existing connections or known addresses (#10015)
Adin Schmahmann committed
Jul 20, 2023 at 11:25 UTC
1fe17a4165da1ea1213b618ff4f47b9588a00f86
1 file changed
+5
-3
core/commands/swarm.go
+5
-3
@@ -650,11 +650,13 @@ var swarmAddrsListenCmd = &cmds.Command{
650
651
var swarmConnectCmd = &cmds.Command{
652
Helptext: cmds.HelpText{
653
- Tagline: "Open connection to a given address.",
653
+ Tagline: "Open connection to a given peer.",
654
ShortDescription: `
655
-'ipfs swarm connect' opens a new direct connection to a peer address.
655
+'ipfs swarm connect' attempts to ensure a connection to a given peer.
656
657
-The address format is an IPFS multiaddr:
657
+Multiaddresses given are advisory, for example the node may already be aware of other addresses for a given peer or may already have an established connection to the peer.
658
+
659
+The address format is a libp2p multiaddr:
660
661
ipfs swarm connect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ
662
`,