summaryrefslogtreecommitdiff
path: root/sites/docs
diff options
context:
space:
mode:
authorJeff Forcier <jeff@bitprophet.org>2019-12-03 10:42:58 -0500
committerJeff Forcier <jeff@bitprophet.org>2019-12-03 10:50:46 -0500
commitdf8765f940c496b5dd42b0896e2f246ba1e2394d (patch)
tree875ca5f71b4d402cc3d08b7169509295b9a1b79b /sites/docs
parentd3b481d1db05dab8745222888482f86d8805160f (diff)
downloadparamiko-df8765f940c496b5dd42b0896e2f246ba1e2394d.tar.gz
Beef up mentions of the need for Invoke, when using Match exec, in the docs
Diffstat (limited to 'sites/docs')
-rw-r--r--sites/docs/api/config.rst14
1 files changed, 9 insertions, 5 deletions
diff --git a/sites/docs/api/config.rst b/sites/docs/api/config.rst
index 8ee0b444..1c3af085 100644
--- a/sites/docs/api/config.rst
+++ b/sites/docs/api/config.rst
@@ -61,11 +61,15 @@ Paramiko releases) are included. A keyword by itself means no known departures.
- ``Host``
- ``HostName``: used in ``%h`` :ref:`token expansion <TOKENS>`
-- ``Match``: fully supported, with the usual caveat that connection-time
- information is not present during config lookup, and thus cannot be used to
- determine matching. This primarily impacts ``Match user``, which can match
- against loaded ``User`` values but has no knowledge about connection-time
- usernames.
+- ``Match``: fully supported, with the following caveats:
+
+ - You must have the optional dependency Invoke installed; see :ref:`the
+ installation docs <paramiko-itself>` (in brief: install
+ ``paramiko[invoke]`` or ``paramiko[everything]``).
+ - As usual, connection-time information is not present during config
+ lookup, and thus cannot be used to determine matching. This primarily
+ impacts ``Match user``, which can match against loaded ``User`` values
+ but has no knowledge about connection-time usernames.
.. versionadded:: 2.7