summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-02-25 18:45:09 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-02-25 18:45:09 -0400
commit425b6fca0046d6fb8ddd8a8a4f2bd77fef52c25d (patch)
treeeec260145fb8df2a8160e6dc3b248751878e381d /doc
parent7b15c2146cb3fcb60a95dd6df435b34bd97e39db (diff)
metadata: FIeld names are now case insensative.
Diffstat (limited to 'doc')
-rw-r--r--doc/design/metadata.mdwn9
-rw-r--r--doc/install/fromscratch.mdwn2
-rw-r--r--doc/metadata.mdwn6
3 files changed, 5 insertions, 12 deletions
diff --git a/doc/design/metadata.mdwn b/doc/design/metadata.mdwn
index 7d1ff4bfa..704738843 100644
--- a/doc/design/metadata.mdwn
+++ b/doc/design/metadata.mdwn
@@ -180,14 +180,7 @@ So, possible approaches:
2 directories representing a metadata field.
Solution might be to compare fields names case-insensitively, and
- pick one representation consistently.
-
- Alternatively, it could escape `A` to `_A` when such a filesystem
- is detected and avoid collisions that way (double `_` to escape it).
- This latter option is ugly, but so are non-posix filesystems.. and it
- also solves any similar issues with case-colliding filenames.
-
- TODO: Check current state of this.
+ pick one representation consistently. **done**
* Assistant needs to know about views, so it can update metadata when
files are moved around inside them. TODO
diff --git a/doc/install/fromscratch.mdwn b/doc/install/fromscratch.mdwn
index 6cc2d90c6..210b6ed7f 100644
--- a/doc/install/fromscratch.mdwn
+++ b/doc/install/fromscratch.mdwn
@@ -26,6 +26,7 @@ quite a lot.
* [extensible-exceptions](http://hackage.haskell.org/package/extensible-exceptions)
* [feed](http://hackage.haskell.org/package/feed)
* [async](http://hackage.haskell.org/package/async)
+ * [case-insensitive](http://hackage.haskell.org/package/case-insensitive)
* [stm](http://hackage.haskell.org/package/stm)
(version 2.3 or newer)
* Optional haskell stuff, used by the [[assistant]] and its webapp
@@ -36,7 +37,6 @@ quite a lot.
* [yesod-static](http://hackage.haskell.org/package/yesod-static)
* [yesod-default](http://hackage.haskell.org/package/yesod-default)
* [data-default](http://hackage.haskell.org/package/data-default)
- * [case-insensitive](http://hackage.haskell.org/package/case-insensitive)
* [http-types](http://hackage.haskell.org/package/http-types)
* [wai](http://hackage.haskell.org/package/wai)
* [wai-logger](http://hackage.haskell.org/package/wai-logger)
diff --git a/doc/metadata.mdwn b/doc/metadata.mdwn
index d3c3b748e..9966e7d7d 100644
--- a/doc/metadata.mdwn
+++ b/doc/metadata.mdwn
@@ -19,9 +19,9 @@ fields, which each can have any number of values. For example, to tag
files, the `tag` field is typically used, with values set to each tag that
applies to the file.
-The field names are limited to alphanumerics (and `[_-.]`). The metadata
-values can contain absolutely anything you like -- but you're recommended
-to keep it simple and reasonably short.
+The field names are limited to alphanumerics (and `[_-.]`), and are case
+insensitive. The metadata values can contain absolutely anything you
+like -- but you're recommended to keep it simple and reasonably short.
Here are some recommended metadata fields to use: