Version 2.1.0 (2016-05-28)

sunaku · May 29, 2016 · b1501de · b1501de
1 parent 4a23f28
commit b1501de
Show file tree

Hide file tree

Showing 24 changed files with 87 additions and 27 deletions.
diff --git a/README.md b/README.md
@@ -2,7 +2,7 @@
 * Docs: <https://sunaku.github.io/dasht/man>
 * Bugs: <https://github.com/sunaku/dasht/issues>
 
-# dasht - Search API docs offline, in your terminal or browser
+# Search API docs offline, in your terminal or browser
 
 dasht is a collection of shell scripts for searching, browsing, and managing
 API documentation (in the form of [150+ offline documentation sets][docsets],
@@ -25,9 +25,8 @@ which aptly characterizes the terminal environment where everything is text.
 
 ### Preview
 
-Watch "[dasht in a terminal](https://vimeo.com/159462598)"
-and "[dasht in a browser](https://vimeo.com/159462774)"
-screencasts on Vimeo.
+Watch the "[dasht in a terminal](https://vimeo.com/159462598)"
+and "[dasht in a browser](https://vimeo.com/159462774)" screencasts.
 
 ![In your terminal](https://github.com/sunaku/dasht/raw/gh-pages/terminal.png)
 ![In your browser](https://github.com/sunaku/dasht/raw/gh-pages/browser.png)
@@ -81,7 +80,7 @@ On any system:
 
 ### Vim integration
 
-Use this (Neo)Vim plugin: https://github.com/sunaku/vim-dasht
+Use the [vim-dasht](https://github.com/sunaku/vim-dasht) plugin for (Neo)Vim.
 
 ### ZSH integration
 

diff --git a/VERSION.md b/VERSION.md
@@ -1,3 +1,64 @@
+## Version 2.1.0 (2016-05-28)
+
+This release improves the feedback users and scripts get from dasht scripts,
+fixes the ability to run dasht from non-setpgid() environments like (Neo)Vim,
+adds TAB completion for ZSH, and provides screencasts for prospective users.
+
+### Minor:
+
+  * dasht(1) now automatically opens the first search result if only one.
+
+  * dasht-query-\* scripts now exit with status 44 when no results found.
+
+  * TAB completion for ZSH (see `etc/zsh/` folder) for all dasht scripts.
+
+    Pressing TAB at the first argument completes `''` and puts you on the
+    second argument, which is perfect for skipping the pattern altogether.
+    Pressing TAB at the second argument completes installed docset names.
+
+    Thanks to Tobias Mersmann (@tmerse) for suggesting this feature and
+    providing starter code at <https://github.com/sunaku/dasht/issues/10>.
+
+  * dasht-server-http(1) now shows "no results found" message in browser.
+
+### Patch:
+
+  * dasht-query-line(1) now sets default URI fragment for Erlang docset.
+
+    This affects modules, like the "dets" result in `dasht dets erlang`.
+
+  * dasht-server-http(1) now opens search result links in the same window.
+
+    w3m(1) opens search result links in the _same_ window, so don't make
+    the experience any different in browsers connected to dasht-server(1).
+
+  * dasht(1) has revised pipefail emulation since Vim doesn't setpgid().
+
+    When `:!dasht some_query_that_has_no_results_here` is run inside Vim,
+    the w3m(1) instance still lives on, even though no results were found,
+    because the child processes of dasht(1) don't inherit its pid as pgid.
+
+    That's why terminating all children with kill(1) on pgid doesn't work.
+    Instead, the new strategy is to selectively kill w3m(1) first and then
+    dasht(1) to achieve the desired effect: no more w3m(1) and nonzero exit.
+
+  * dasht(1) now avoids `/bin/sh: line 1: Terminated` warning under BASH.
+
+    To ensure normal SIGTERM propagation to children, trap SIGUSR1 instead.
+
+  * Revised "no results found" messages for HTML and text user interfaces.
+
+### Other:
+
+  * README: add screencasts of dasht in the terminal and browser:
+
+    Watch the "[dasht in a terminal](https://vimeo.com/159462598)"
+    and "[dasht in a browser](https://vimeo.com/159462774)" screencasts.
+
+  * README: add link to vim-dasht plugin for (Neo)Vim integration:
+
+    https://github.com/sunaku/vim-dasht
+
 ## Version 2.0.0 (2016-03-17)
 
 This release improves the local search engine's responsiveness, usability, and

diff --git a/bin/dasht b/bin/dasht
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT 1                       2016-03-17                            2.0.0
+# # DASHT 1                       2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets b/bin/dasht-docsets
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS 1               2016-03-17                            2.0.0
+# # DASHT-DOCSETS 1               2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-extract b/bin/dasht-docsets-extract
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-EXTRACT 1       2016-03-17                            2.0.0
+# # DASHT-DOCSETS-EXTRACT 1       2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-install b/bin/dasht-docsets-install
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-INSTALL 1       2016-03-17                            2.0.0
+# # DASHT-DOCSETS-INSTALL 1       2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-remove b/bin/dasht-docsets-remove
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-REMOVE 1        2016-03-17                            2.0.0
+# # DASHT-DOCSETS-REMOVE 1        2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-docsets-update b/bin/dasht-docsets-update
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-DOCSETS-UPDATE 1        2016-03-17                            2.0.0
+# # DASHT-DOCSETS-UPDATE 1        2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-query-exec b/bin/dasht-query-exec
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-QUERY-EXEC 1            2016-03-17                            2.0.0
+# # DASHT-QUERY-EXEC 1            2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-query-html b/bin/dasht-query-html
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-QUERY-HTML 1            2016-03-17                            2.0.0
+# # DASHT-QUERY-HTML 1            2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-query-line b/bin/dasht-query-line
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-QUERY-LINE 1            2016-03-17                            2.0.0
+# # DASHT-QUERY-LINE 1            2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-server b/bin/dasht-server
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-SERVER 1                2016-03-17                            2.0.0
+# # DASHT-SERVER 1                2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/bin/dasht-server-http b/bin/dasht-server-http
@@ -1,6 +1,6 @@
 #!/bin/sh -e
 #
-# # DASHT-SERVER-HTTP 1           2016-03-17                            2.0.0
+# # DASHT-SERVER-HTTP 1           2016-05-28                            2.1.0
 #
 # ## NAME
 #

diff --git a/man/man1/dasht-docsets-extract.1 b/man/man1/dasht-docsets-extract.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-EXTRACT 1       2016\-03\-17                            2.0.0
+.TH DASHT\-DOCSETS\-EXTRACT 1       2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-docsets\-extract \- extracts Dash \[la]https://kapeli.com/dash\[ra] docset archives (\fB\fC*.tgz\fR files)

diff --git a/man/man1/dasht-docsets-install.1 b/man/man1/dasht-docsets-install.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-INSTALL 1       2016\-03\-17                            2.0.0
+.TH DASHT\-DOCSETS\-INSTALL 1       2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-docsets\-install \- installs new Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-docsets-remove.1 b/man/man1/dasht-docsets-remove.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-REMOVE 1        2016\-03\-17                            2.0.0
+.TH DASHT\-DOCSETS\-REMOVE 1        2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-docsets\-remove \- removes installed Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-docsets-update.1 b/man/man1/dasht-docsets-update.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS\-UPDATE 1        2016\-03\-17                            2.0.0
+.TH DASHT\-DOCSETS\-UPDATE 1        2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-docsets\-update \- updates installed Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-docsets.1 b/man/man1/dasht-docsets.1
@@ -1,4 +1,4 @@
-.TH DASHT\-DOCSETS 1               2016\-03\-17                            2.0.0
+.TH DASHT\-DOCSETS 1               2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-docsets \- lists installed Dash \[la]https://kapeli.com/dash\[ra] docsets

diff --git a/man/man1/dasht-query-exec.1 b/man/man1/dasht-query-exec.1
@@ -1,4 +1,4 @@
-.TH DASHT\-QUERY\-EXEC 1            2016\-03\-17                            2.0.0
+.TH DASHT\-QUERY\-EXEC 1            2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-query\-exec \- searches a Dash \[la]https://kapeli.com/dash\[ra] docset's SQLite3 database file

diff --git a/man/man1/dasht-query-html.1 b/man/man1/dasht-query-html.1
@@ -1,4 +1,4 @@
-.TH DASHT\-QUERY\-HTML 1            2016\-03\-17                            2.0.0
+.TH DASHT\-QUERY\-HTML 1            2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-query\-html \- searches Dash \[la]https://kapeli.com/dash\[ra] docsets and emits HTML table rows

diff --git a/man/man1/dasht-query-line.1 b/man/man1/dasht-query-line.1
@@ -1,4 +1,4 @@
-.TH DASHT\-QUERY\-LINE 1            2016\-03\-17                            2.0.0
+.TH DASHT\-QUERY\-LINE 1            2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-query\-line \- searches Dash \[la]https://kapeli.com/dash\[ra] docsets and emits groups of lines

diff --git a/man/man1/dasht-server-http.1 b/man/man1/dasht-server-http.1
@@ -1,4 +1,4 @@
-.TH DASHT\-SERVER\-HTTP 1           2016\-03\-17                            2.0.0
+.TH DASHT\-SERVER\-HTTP 1           2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-server\-http \- simple search engine that powers 

diff --git a/man/man1/dasht-server.1 b/man/man1/dasht-server.1
@@ -1,4 +1,4 @@
-.TH DASHT\-SERVER 1                2016\-03\-17                            2.0.0
+.TH DASHT\-SERVER 1                2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht\-server \- runs a local search engine for your web browser

diff --git a/man/man1/dasht.1 b/man/man1/dasht.1
@@ -1,4 +1,4 @@
-.TH DASHT 1                       2016\-03\-17                            2.0.0
+.TH DASHT 1                       2016\-05\-28                            2.1.0
 .SH NAME
 .PP
 dasht \- API documentation in your terminal