summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Joey Hess <id@joeyh.name>2014-12-02 14:50:58 -0400
committerGravatar Joey Hess <id@joeyh.name>2014-12-02 14:50:58 -0400
commit19ab101843af025ab69beb6f021a275671b2c460 (patch)
tree72dee950585d3b27dc7fb929108e88ac43cf12d3
parent63c83896efd2560ecc5d3c74906e417e15c7c189 (diff)
comment
-rw-r--r--doc/forum/metadata_limits/comment_1_a20bbe49f2f23d23131221ec79c8b973._comment28
-rw-r--r--doc/metadata.mdwn2
2 files changed, 29 insertions, 1 deletions
diff --git a/doc/forum/metadata_limits/comment_1_a20bbe49f2f23d23131221ec79c8b973._comment b/doc/forum/metadata_limits/comment_1_a20bbe49f2f23d23131221ec79c8b973._comment
new file mode 100644
index 000000000..d296a1cb9
--- /dev/null
+++ b/doc/forum/metadata_limits/comment_1_a20bbe49f2f23d23131221ec79c8b973._comment
@@ -0,0 +1,28 @@
+[[!comment format=mdwn
+ username="joey"
+ subject="""comment 1"""
+ date="2014-12-02T18:39:34Z"
+ content="""
+There's no particular size limit for metadata. But things may not scale
+well past some size.
+
+Having a big metadata value could make git-annex be a little slow when
+dealing with metadata, since it has to parse the metadata log file.
+So if you stored say, 1 mb in metadata, that's one mb of disk IO and data
+processing every time git-annex looks at the metadata for that file.
+
+All the metadata for a file will also be buffered in memory when git-annex
+is looking at that file's metadata. So `git-annex view` would use 1 mb or
+so more memory in the above example. (But git-annex only looks at one
+file's metadata at a time, so its memory use won't grow if you have a lot
+of files with metadata.)
+
+Also of course, the metadata is stored in git, and so it will make your git
+repository bigger.
+
+I would not expect any reasonable description of a photo to be large enough
+for its size to be a problem.
+
+I'd even feel ok with putting the full text of a license in as metadata
+(GPL is 30kb, and git would deduplicate redundant license metadata).
+"""]]
diff --git a/doc/metadata.mdwn b/doc/metadata.mdwn
index fed332351..f1f0ceab7 100644
--- a/doc/metadata.mdwn
+++ b/doc/metadata.mdwn
@@ -21,7 +21,7 @@ applies to the file.
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.
+like -- but you're recommended to keep it simple and [[reasonably short|forum/metadata_limits]]
Here are some metadata fields that git-annex has special support for: