From: Sergey Matveev <stargrave@stargrave.org>
Date: Thu, 14 Mar 2024 18:30:31 +0000 (+0300)
Subject: Note about tags filtering
X-Git-Url: http://www.git.stargrave.org/?a=commitdiff_plain;h=5169b38da07122ddc9df05f7baf83c75c9fe800dd687a52182e9fa444f19938d;p=schwabrak.git

Note about tags filtering
---

diff --git a/README b/README
index 64d38e1..28f7576 100644
--- a/README
+++ b/README
@@ -41,7 +41,7 @@ Each issue can have attached tags. For keeping their set in consistent
 well-defined state, the tags/ directory above the issues/ contains
 available tags for your projects.
 
-    $ for tag in status:open status:done assigned:alice assigned:bob
+    $ for tag in status:open status:done assignee:alice assignee:bob
         doc db test:integration severity:high severity:low ... ; do
             touch tags/$tag
     done
@@ -96,15 +96,25 @@ arguments, but proj/issue-name-to-create will be created as expected.
 
 All utilities strip off possible "issues/" prefix from the issues
 name, so you can easily complete issue names with something like fzf.
-"cd" utility exactly runs fzf to show you available issues, outputing
+"cd" utility exactly runs fzf to show you available issues, outputting
 path to selected one.
 
 "list" lists all issues in tab separated format, sorting by descending
-creation date and showing their tags. "tag-list issue" prints issue's
-tags if any. "tag-add (issues/)issue (tags/)tag" adds a tag, as was
-noticed before. "dep-add issue-dst issue-src" will link issue-src in
-issues-dst's deps/. "show issue" shows most of issue's information in
-human friendly way.
+creation date and showing their tags. Optional arguments acts like a
+filter for the issue's tags.
+
+    $ ~s/list open stargrave !hidden
+
+That will list all issues with the tags including "status:open" AND
+"assignee:stargrave", AND excluding issues with the tags containing
+"hidden". Each argument is an expression each issue's tag is compared to
+(zsh'es "=~" test). Tag with "!"-prefix means that no tag should be in
+issue's set.
+
+"tag-list issue" prints issue's tags if any.
+"tag-add issue [tags/]tag" adds a tag, as was noticed before.
+"dep-add issue-dst issue-src" will link issue-src in issues-dst's deps/.
+"show issue" shows most of issue's information in human friendly way.
 
 comment-list, recfile-export and recfile-export-all produces
 recutils'es compatible recfile output, which is machine friendlier.