emacs-elpa-diffs
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[elpa] externals/ssh-deploy e08b8bb 044/133: Improved documentation


From: Stefan Monnier
Subject: [elpa] externals/ssh-deploy e08b8bb 044/133: Improved documentation
Date: Sat, 27 Mar 2021 14:48:40 -0400 (EDT)

branch: externals/ssh-deploy
commit e08b8bbf3ef9560557b881702179786154df240e
Author: Christian Johansson <christian@cvj.se>
Commit: Christian Johansson <christian@cvj.se>

    Improved documentation
---
 README.md     | 6 +++---
 ssh-deploy.el | 7 +++----
 2 files changed, 6 insertions(+), 7 deletions(-)

diff --git a/README.md b/README.md
index 44efd34..5e5967a 100644
--- a/README.md
+++ b/README.md
@@ -41,11 +41,11 @@ Here is a list of other variables you can set globally or 
per directory:
 * `ssh-deploy-remote-sql-server` Default server when connecting to remote SQL 
database *(string)*
 * `ssh-deploy-remote-sql-user` Default user when connecting to remote SQL 
database *(string)*
 * `ssh-deploy-remote-shell-executable` Default remote shell executable when 
launching shell on remote host *(string)*
-* `ssh-deploy-verbose` Show messages in message buffer when starting and 
ending actions, default t *(integer)*
+* `ssh-deploy-verbose` Show messages in message buffer when starting and 
ending actions *(integer)*
 * `ssh-deploy-script` - Your custom lambda function that will be called using 
(funcall) when running deploy script handler *(function)*
-* `ssh-deploy-async-with-threads` - Whether to use threads (make threads) 
instead of processes (async-start) for asynchronous operations, default nil 
*(integer)*
+* `ssh-deploy-async-with-threads` - Whether to use threads (make threads) 
instead of processes (async-start) for asynchronous operations *(integer)*
 
-When integers are used as booleans, above zero equals true and otherwise it's 
false.
+When integers are used as booleans, above zero means true, zero means false 
and nil means unset and fallback to global settings.
 
 ## Deployment configuration examples
 
diff --git a/ssh-deploy.el b/ssh-deploy.el
index 40d76fb..67d444b 100644
--- a/ssh-deploy.el
+++ b/ssh-deploy.el
@@ -123,11 +123,11 @@
 ;; * `ssh-deploy-remote-sql-server' - Default server when connecting to remote 
SQL database *(string)*
 ;; * `ssh-deploy-remote-sql-user' - Default user when connecting to remote SQL 
database *(string)*
 ;; * `ssh-deploy-remote-shell-executable' - Default shell executable when 
launching shell on remote host *(string)*
-;; * `ssh-deploy-verbose' - Show messages in message buffer when starting and 
ending actions, default t *(integer)*
+;; * `ssh-deploy-verbose' - Show messages in message buffer when starting and 
ending actions *(integer)*
 ;; * `ssh-deploy-script' - Our custom lambda function that will be called 
using (funcall) when running deploy script *(function)*
-;; * `ssh-deploy-async-with-threads' - Whether to use threads (make threads) 
instead of processes (async-start) for asynchronous operations, default nil 
*(integer)*
+;; * `ssh-deploy-async-with-threads' - Whether to use threads (make threads) 
instead of processes (async-start) for asynchronous operations *(integer)*
 ;;
-;; When integers are used as booleans, above zero equals true and otherwise 
it's false.
+;; When integers are used as booleans, above zero means true, zero means false 
and nil means unset and fallback to global settings.
 ;;
 ;; Please see README.md from the same repository for more extended 
documentation.
 
@@ -1443,4 +1443,3 @@
 
 (provide 'ssh-deploy)
 ;;; ssh-deploy.el ends here
-



reply via email to

[Prev in Thread] Current Thread [Next in Thread]