summaryrefslogtreecommitdiff
path: root/Annex
diff options
context:
space:
mode:
authorGravatar Joey Hess <joeyh@joeyh.name>2017-05-11 14:37:24 -0400
committerGravatar Joey Hess <joeyh@joeyh.name>2017-05-11 14:37:24 -0400
commit60dfbb240d4db6cb1a6f8ca9cf71400d461d8aa5 (patch)
tree6d62615466079c11beebaaba8d22a2d22dfcc310 /Annex
parentb239c72dc5198155edda37b6e726ba2589c4a2aa (diff)
improve comment
Diffstat (limited to 'Annex')
-rw-r--r--Annex/Ssh.hs5
1 files changed, 3 insertions, 2 deletions
diff --git a/Annex/Ssh.hs b/Annex/Ssh.hs
index bf13a02c4..ae14a560f 100644
--- a/Annex/Ssh.hs
+++ b/Annex/Ssh.hs
@@ -158,8 +158,9 @@ portParams :: Maybe Integer -> [CommandParam]
portParams Nothing = []
portParams (Just port) = [Param "-p", Param $ show port]
-{- Prepare to use a socket file. Locks a lock file to prevent
- - other git-annex processes from stopping the ssh on this socket. -}
+{- Prepare to use a socket file for ssh connection caching.
+ - Locks a lock file to prevent other git-annex processes from
+ - stopping the ssh multiplexer on this socket. -}
prepSocket :: FilePath -> Annex ()
prepSocket socketfile = do
-- If the lock pool is empty, this is the first ssh of this