summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2014-03-26 16:55:29 -0400
committerGravatar Joey Hess <joey@kitenet.net>2014-03-26 16:55:29 -0400
commit42f37af295a7b41e089360604576f1562c43f0d0 (patch)
treeca9e3c909f8ff02af26f860c197d8bae9b1c38ab /doc
parent5fbe7f4cc5da0269242552673d786a869373262e (diff)
improve metadata documentation
Diffstat (limited to 'doc')
-rw-r--r--doc/bugs/set_metadata_on_wrong_files.mdwn2
-rw-r--r--doc/git-annex.mdwn5
-rw-r--r--doc/metadata.mdwn8
3 files changed, 9 insertions, 6 deletions
diff --git a/doc/bugs/set_metadata_on_wrong_files.mdwn b/doc/bugs/set_metadata_on_wrong_files.mdwn
index add68bae5..e31714784 100644
--- a/doc/bugs/set_metadata_on_wrong_files.mdwn
+++ b/doc/bugs/set_metadata_on_wrong_files.mdwn
@@ -86,3 +86,5 @@ metadata c.txt
num=3
ok
"""]]
+
+> [[fixed|done]]; documentation improved --[[Joey]]
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 6e9f39826..51f618d0a 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -711,8 +711,9 @@ subdirectories).
* `metadata [path ...] [-s field=value -s field+=value -s field-=value ...] [-g field]`
- Each file can have any number of metadata fields attached to it,
- which each in turn have any number of values.
+ The content of a file can have any number of metadata fields
+ attached to it to describe it. Each metadata field can in turn
+ have any number of values.
This command can be used to set metadata, or show the currently set
metadata.
diff --git a/doc/metadata.mdwn b/doc/metadata.mdwn
index 9f3c314fa..684820cb9 100644
--- a/doc/metadata.mdwn
+++ b/doc/metadata.mdwn
@@ -1,7 +1,7 @@
-git-annex allows you to store arbitrary metadata about files stored in the
-git-annex repository. The metadata is stored in the `git-annex` branch, and
-so is automatically kept in sync with the rest of git-annex's state, such
-as [[location_tracking]] information.
+git-annex allows you to store arbitrary metadata about the content of files
+stored in the git-annex repository. The metadata is stored in the
+`git-annex` branch, and so is automatically kept in sync with the rest of
+git-annex's state, such as [[location_tracking]] information.
Some of the things you can do with metadata include: