[elpa] master 2b01ad8 137/187: Merge branch 'master' of github.com:jwiegley/emacs-async

[Michael Albinus]

branch: master
commit 2b01ad883c834062fb1ac1000fa4d494c79bf461
Merge: a921e5f 2f28229
Author: Thierry Volpiatto <address@hidden>
Commit: Thierry Volpiatto <address@hidden>

    Merge branch 'master' of github.com:jwiegley/emacs-async
---
 README.md         |   45 +++++++++++++++++++++++----------------------
 async-bytecomp.el |    2 +-
 async-test.el     |    4 ++++
 async.el          |    3 ++-
 4 files changed, 30 insertions(+), 24 deletions(-)

diff --git a/README.md b/README.md
index c132a97..bc764ba 100644
--- a/README.md
+++ b/README.md
@@ -1,10 +1,10 @@
 # emacs-async
 
-async.el is a module for doing asynchronous processing in Emacs.
+`async.el` is a module for doing asynchronous processing in Emacs.
 
 # Install
 
-Add to your .emacs.el:
+Add to your `.emacs.el`:
 
      (when (require 'dired-aux)
        (require 'dired-async))
@@ -26,7 +26,7 @@ The interface is intended to be very easy to use:
 ## async-start
 
     async-start START-FUNC FINISH-FUNC
-    
+
 Execute START-FUNC (often a lambda) in a subordinate Emacs process.  When
 done, the return value is passed to FINISH-FUNC.  Example:
 
@@ -40,9 +40,9 @@ done, the return value is passed to FINISH-FUNC.  Example:
        ;; What to do when it finishes
        (lambda (result)
          (message "Async process done, result should be 222: %s" result)))
-             
-If FINISH-FUNC is nil or missing, a future is returned that can be inspected
-using `async-get', blocking until the value is ready.  Example:
+
+If FINISH-FUNC is `nil` or missing, a future is returned that can be inspected
+using `async-get`, blocking until the value is ready.  Example:
 
     (let ((proc (async-start
                    ;; What to do in the child process
@@ -57,8 +57,8 @@ using `async-get', blocking until the value is ready.  
Example:
                  (async-get proc)))
 
 If you don't want to use a callback, and you don't care about any return value
-form the child process, pass the `'ignore` symbol as the second argument (if
-you don't, and never call `async-get`, it will leave *emacs* process buffers
+from the child process, pass the `'ignore` symbol as the second argument (if
+you don't, and never call `async-get`, it will leave ``*emacs*`` process 
buffers
 hanging around):
 
     (async-start
@@ -67,33 +67,34 @@ hanging around):
      'ignore)
 
 Note: Even when FINISH-FUNC is present, a future is still returned except that
-it yields no value (since the value is passed to FINISH-FUNC).  Call
-`async-get' on such a future always returns nil.  It can still be useful,
-however, as an argument to `async-ready' or `async-wait'.
+it yields no value (since the value is passed to FINISH-FUNC).  Calling
+`async-get` on such a future always returns `nil`.  It can still be useful,
+however, as an argument to `async-ready` or `async-wait`.
 
 ## async-start-process
 
     async-start-process NAME PROGRAM FINISH-FUNC &rest PROGRAM-ARGS
-    
-Start the executable PROGRAM asynchronously.  See `async-start'.  PROGRAM is
+
+Start the executable PROGRAM asynchronously.  See `async-start`.  PROGRAM is
 passed PROGRAM-ARGS, calling FINISH-FUNC with the process object when done.
-If FINISH-FUNC is nil, the future object will return the process object when
-the program is finished.
+If FINISH-FUNC is `nil`, the future object will return the process object when
+the program is finished.  Set DEFAULT-DIRECTORY to change PROGRAM's current
+working directory.
 
 ## async-get
 
     async-get FUTURE
-    
-Get the value from an asynchronously function when it is ready.  FUTURE is
-returned by `async-start' or `async-start-process' when its FINISH-FUNC is
-nil.
+
+Get the value from an asynchronously called function when it is ready.  FUTURE 
is
+returned by `async-start` or `async-start-process` when its FINISH-FUNC is
+`nil`.
 
 ## async-ready
 
     async-ready FUTURE
 
-Query a FUTURE to see if the ready is ready -- i.e., if no blocking
-would result from a call to `async-get' on that FUTURE.
+Query a FUTURE to see if its function's value is ready -- i.e., if no blocking
+would result from a call to `async-get` on that FUTURE.
 
 ## async-wait
 
@@ -105,7 +106,7 @@ Wait for FUTURE to become ready.
 
     async-inject-variables INCLUDE-REGEXP &optional PREDICATE EXCLUDE-REGEXP
 
-Return a `setq' form that replicates part of the calling environment.  It sets
+Return a `setq` form that replicates part of the calling environment.  It sets
 the value for every variable matching INCLUDE-REGEXP and also PREDICATE.  It
 will not perform injection for any variable matching EXCLUDE-REGEXP (if
 present).  It is intended to be used as follows:
diff --git a/async-bytecomp.el b/async-bytecomp.el
index eaf3ad5..f7d582d 100644
--- a/async-bytecomp.el
+++ b/async-bytecomp.el
@@ -70,7 +70,7 @@ All *.elc files are systematically deleted before proceeding."
                       (save-excursion
                         (goto-char (point-min))
                         (while (re-search-forward "^.*:Error:" nil t)
-                          (incf n)))
+                          (cl-incf n)))
                       (if (> n 0)
                           (message "Failed to compile %d files in directory 
`%s'" n ,directory)
                           (message "Directory `%s' compiled asynchronously 
with warnings" ,directory)))))
diff --git a/async-test.el b/async-test.el
index 1fb49e3..05c1043 100644
--- a/async-test.el
+++ b/async-test.el
@@ -134,3 +134,7 @@
 (provide 'async-test)
 
 ;;; async-test.el ends here
+
+;; Local Variables:
+;; no-byte-compile: t
+;; End:
diff --git a/async.el b/async.el
index d44f14a..be9c04e 100644
--- a/async.el
+++ b/async.el
@@ -200,7 +200,8 @@ its FINISH-FUNC is nil."
 PROGRAM is passed PROGRAM-ARGS, calling FINISH-FUNC with the
 process object when done.  If FINISH-FUNC is nil, the future
 object will return the process object when the program is
-finished."
+finished.  Set DEFAULT-DIRECTORY to change PROGRAM's current
+working directory."
   (let* ((buf (generate-new-buffer (concat "*" name "*")))
          (proc (let ((process-connection-type nil))
                  (apply #'start-process name buf program program-args))))