tools/upload: clarify instructions in comments

This commit is contained in:
Henrik Lissner 2018-09-19 23:48:05 -04:00
parent f415762e8b
commit 40a2fffac7
No known key found for this signature in database
GPG key ID: 5F6C0EA160557395

View file

@ -1,17 +1,16 @@
;;; tools/upload/config.el -*- lexical-binding: t; -*-
;; Uses `ssh-deploy' to map a local folder to a remote one. Use
;; `ssh-deploy-root-remote' and `ssh-deploy-root-local' to set up this mapping.
;; Uses `ssh-deploy' to map a local folder to a remote one. Set
;; `ssh-deploy-root-remote' and `ssh-deploy-root-local' in a .dir-locals.el file
;; to establish this mapping.
;;
;; Example:
;; (setq ssh-deploy-root-local "/home/hlissner/work/site/"
;; ssh-deploy-root-remote "/ssh:hlissner@myserver.com:/var/www/site/"
;; ssh-deploy-on-explicity-save t)
;; ((nil . ((ssh-deploy-root-local . "/local/path/to/project")
;; (ssh-deploy-root-remote . "/ssh:user@server:/remote/project/")
;; (ssh-deploy-on-explicity-save . t))))
;;
;; Note: `ssh-deploy-root-local' is optional, and will resort to
;; `doom-project-root' if unspecified.
;;
;; Can be used via .dir-locals.el file in your project.
(def-package! ssh-deploy
:commands (ssh-deploy-upload-handler