From e0954610cefa6b8f109e9771d0676c50309cdc5d Mon Sep 17 00:00:00 2001 From: Adin Schmahmann Date: Thu, 6 Jul 2023 22:38:57 -0400 Subject: [PATCH] docs(commands): explain that swarm connect can reuse existing connections or known addresses --- core/commands/swarm.go | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/core/commands/swarm.go b/core/commands/swarm.go index c9259bef0e3..3d2adb7575d 100644 --- a/core/commands/swarm.go +++ b/core/commands/swarm.go @@ -650,11 +650,13 @@ var swarmAddrsListenCmd = &cmds.Command{ var swarmConnectCmd = &cmds.Command{ Helptext: cmds.HelpText{ - Tagline: "Open connection to a given address.", + Tagline: "Open connection to a given peer.", ShortDescription: ` -'ipfs swarm connect' opens a new direct connection to a peer address. +'ipfs swarm connect' attempts to ensure a connection to a given peer. -The address format is an IPFS multiaddr: +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. + +The address format is a libp2p multiaddr: ipfs swarm connect /ip4/104.131.131.82/tcp/4001/p2p/QmaCpDMGvV2BGHeYERUEnRQAwe3N8SzbUtfsmvsqQLuvuJ `,