summaryrefslogtreecommitdiff
path: root/doc/design
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-02-22 16:09:00 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-02-22 16:27:53 -0400
commit5463fc4d8df52be0c0232f1c44956b2227ad193c (patch)
tree962f51d8ea211be290184077ed53667441b3b3b7 /doc/design
parentad42a4de9c5fa08456de01b5e41350fff4499189 (diff)
views: add automatically constructed file location metadata
When constructing views, metadata is available about the location of the file in the view's reference branch. Allows incorporating parts of the directory hierarchy in a view. For example `git annex view tag=* podcasts/=*` makes a view in the form tag/showname. Performance impact: I benchmarked git annex view tag=* in the conference proceedings repo to take 6.459s before this change, and 6.544s after. FWIW, I considered making the syntax for this be podcasts/*, which might be easier for the user to learn. However, I think it's not as good: * The user has to then juggle two different syntaxes, and podcasts/* will be expanded by the shell so they also need to quote it, while podcasts/=* is unlikely to be expanded by the shell. * It would allow for things like podcasts/*/* and *.mp3 which do not map well into views. This commit was sponsored by Aurélien Pinceaux.
Diffstat (limited to 'doc/design')
-rw-r--r--doc/design/metadata.mdwn9
1 files changed, 5 insertions, 4 deletions
diff --git a/doc/design/metadata.mdwn b/doc/design/metadata.mdwn
index db0d51c5c..c700e3674 100644
--- a/doc/design/metadata.mdwn
+++ b/doc/design/metadata.mdwn
@@ -70,7 +70,7 @@ metadata is derived, at least year=yyyy and probably also month, etc.
### directory hierarchy metadata
-TODO From the original filename used in the master branch, when
+From the original filename used in the master branch, when
constructing a view, generate fields. For example foo/bar/baz.mp3
would get /=foo, foo/=bar, foo/bar/=baz, and .=mp3.
@@ -82,11 +82,12 @@ This allows using whatever directory hierarchy exists to inform the view,
without locking the view into using it.
Complication: When refining a view, it only looks at the filenames in
-the view, so it would need to map from
+the view, so it has to map from
those filenames to derive the same metadata, unless there is persistent
storage. Luckily, the filenames used in the views currently include the
-subdirs (although not quite in a parseable format, would need some small
-changes).
+subdirs.
+
+**done**!
# other uses for metadata