branch: externals/dtache
commit 1bc60af5a0166e24a423a6a9744543a62953d7b6
Author: Niklas Eklund <[email protected]>
Commit: Niklas Eklund <[email protected]>
Update changelog and readme
---
CHANELOG.org | 3 ++-
README.org | 16 ++++++++--------
2 files changed, 10 insertions(+), 9 deletions(-)
diff --git a/CHANELOG.org b/CHANELOG.org
index dec05de4f1..ec183768c1 100644
--- a/CHANELOG.org
+++ b/CHANELOG.org
@@ -4,7 +4,8 @@
* Development
-- Remove external dependency to marginalia. Dtache now implements annotations
for all users.
+- Remove external dependency to =embark=. The package now implements an action
map that can be used with/without embark.
+- Remove external dependency to =marginalia=. The package now provides
annotations for all users.
- Fix error in =dtache-env= usage. The integration wasn't correct which
resulted in =dtache= failing to execute some commands properly
- Make =dtache-env= optional rather than required. =Dtache= should be fine
without it, just that automatic status labeling will not be run
diff --git a/README.org b/README.org
index ab8486b0f7..b786ee1b25 100644
--- a/README.org
+++ b/README.org
@@ -74,7 +74,7 @@ There are two convenient ways of listing sessions and acting
upon one.
** Actions on sessions
-General commands that can be used either in =dtache-list-sessions= or in
=dtache-open-session= (using the embark extension).
+Session commands that can be used in either =dtache-list-sessions= or in
=dtache-open-session=.
| Command | Description |
|-------------------------------+---------------------------------------------|
@@ -113,22 +113,22 @@ Commands to be used in shell buffers.
| dtache-shell-attach | Attach to a session |
| dtache-shell-detach | Detach from a session |
-** TODO Embark
+* Tips & Tricks
+** Actions
-Add [[https://github.com/oantolin/embark/][embark]] actions to
=dtache-open-session= by adding the following to the configuration.
+To act on sessions the user can either bind the =dtache-action-map= to a
binding of there choice. An example could be.
#+begin_src elisp
- (defvar embark-dtache-map (make-composed-keymap dtache-action-map
embark-general-map))
- (add-to-list 'embark-keymap-alist '(dtache . embark-dtache-map))
+ (global-set-key (kbd "C-c d") dtache-action-map)
#+end_src
-The user can also bind the =dtache-action-map= to a keybinding of choice.
+Or if the user has the package [[https://github.com/oantolin/embark/][embark]]
installed the actions could be integrated with that package by adding the
following to the =dtache= configuration.
#+begin_src elisp
- (global-set-key (kbd "C-c d") dtache-action-map)
+ (defvar embark-dtache-map (make-composed-keymap dtache-action-map
embark-general-map))
+ (add-to-list 'embark-keymap-alist '(dtache . embark-dtache-map))
#+end_src
-* Tips & Tricks
** Automatic status labeling
The =dtache-env= script found in this repository can be used to execute shell
commands in a controlled environment. This environment makes sure that the exit
status is present in the session's output. This makes it possible for =dtache=
to automatically label a session with either =success= or =failure=.
