branch: externals/ssh-deploy
commit d117b9bb54376719aeea8281c92726afde9fff19
Author: Christian Johansson <[email protected]>
Commit: Christian Johansson <[email protected]>
Improved documentation
---
README.md | 2 +-
ssh-deploy.el | 2 +-
2 files changed, 2 insertions(+), 2 deletions(-)
diff --git a/README.md b/README.md
index 1f5d479..a7ddd2b 100644
--- a/README.md
+++ b/README.md
@@ -22,7 +22,7 @@ This application is made by Christian Johansson
<[email protected]> 2016-2017 and
Here is a list of other variables you can set globally or per directory:
* `ssh-deploy-root-local` The local root that should be under deployment
*(string)*
-* `ssh-deploy-root-remote` The remote root that should be under deployment,
should follow a `/protocol:user@host:path` format *(string)*
+* `ssh-deploy-root-remote` The remote TRAMP root that is used for deployment
*(string)*
* `ssh-deploy-debug` Enables debugging messages *(boolean)*
* `ssh-deploy-revision-folder` The folder used for storing local revisions
*(string)*
* `ssh-deploy-automatically-detect-remote-changes` Enables automatic detection
of remote changes *(boolean)*
diff --git a/ssh-deploy.el b/ssh-deploy.el
index bc68083..14c004c 100644
--- a/ssh-deploy.el
+++ b/ssh-deploy.el
@@ -83,7 +83,7 @@
;; Here is a list of other variables you can set globally or per directory:
;; * ssh-deploy-root-local - The local root that should be under deployment
*(string)*
-;; * ssh-deploy-root-remote - The remote root that should be under deployment,
should follow a `/protocol:user@host:path` format *(string)*
+;; * ssh-deploy-root-remote - The remote TRAMP root that is used for
deployment *(string)*
;; * ssh-deploy-debug - Enables debugging messages *(boolean)*
;; * ssh-deploy-revision-folder - The folder used for storing local revisions
*(string)*
;; * ssh-deploy-automatically-detect-remote-changes - Enables automatic
detection of remote changes *(boolean)*
