comment
authorJoey Hess <joeyh@joeyh.name>
Mon, 16 Jan 2023 19:52:52 +0000 (15:52 -0400)
committerJoey Hess <joeyh@joeyh.name>
Mon, 16 Jan 2023 19:52:52 +0000 (15:52 -0400)
doc/git-annex-find/comment_17_b24572ef407439b6976ee72b2bea888f._comment
doc/todo/findkeys.mdwn [new file with mode: 0644]

index 62c4602003636a2cdcdf6ef2fd51e74c00cb8a40..2112ef34a8b88261220786b98d33ba0e099f962e 100644 (file)
@@ -6,5 +6,5 @@
 Reminder that this is a man page, and place to maybe ask for clarification
 about that documentation. It is not a place to post feature requests.
 
-[[todo]] would be a good place to talk about a `git-annex findkeys`.
+Opened a todo, [[todo/findkeys]]
 """]]
diff --git a/doc/todo/findkeys.mdwn b/doc/todo/findkeys.mdwn
new file mode 100644 (file)
index 0000000..70387c0
--- /dev/null
@@ -0,0 +1,23 @@
+`git-annex findkeys` would be similar to `git-annex find`, but would find
+all keys in the repository, or all known keys.
+
+[[git-annex-find]] has a long comment section with users wanting some way
+to do this, but I am strongly of the opinion that `git-annex find` should
+list files, not keys, like `find(1)` does. See my comments there.
+--[[Joey]]
+
+findkeys could support --format like find, but without `${file}`, and
+--print0 and the json options. --batch does not seem very likely to be
+useful? The other options wouldn't apply to it, except for matching options
+like --in that can operate on keys.
+
+Seems that some users are looking for a way to list all keys known to
+git-annex, while other users are looking for a way to list only keys
+present in the local repo. If it defaults to listing all known keys,
+--in=here can be used to get the other behavior. OTOH, `git-annex find`
+defaults to listing only files that are present, so it would be
+a little inconsistent for findkeys to default to listing all keys.
+I think I prefer the inconsistency over needing a different option than
+--in=here though. --[[Joey]]
+
+[[!tag projects/dandi]]