new section for metadata

This commit is contained in:
Joey Hess 2014-02-19 14:55:34 -04:00
parent 39ebfa1a2e
commit e7672f197e
6 changed files with 42 additions and 38 deletions

View file

@ -18,7 +18,7 @@ import Data.Time.Clock.POSIX
def :: [Command]
def = [withOptions [setOption] $ command "metadata" paramPaths seek
SectionUtility "sets metadata of a file"]
SectionMetaData "sets metadata of a file"]
setOption :: Option
setOption = Option ['s'] ["set"] (ReqArg mkmod "FIELD[+-]=VALUE") "set metadata"

View file

@ -15,7 +15,7 @@ import Command.View (paramView, parseViewParam, checkoutViewBranch)
def :: [Command]
def = [notBareRepo $ notDirect $
command "vadd" paramView seek SectionUtility "refine current view"]
command "vadd" paramView seek SectionMetaData "refine current view"]
seek :: CommandSeek
seek = withWords start

View file

@ -18,7 +18,7 @@ import Command.View (checkoutViewBranch)
def :: [Command]
def = [notBareRepo $ notDirect $
command "vpop" (paramOptional paramNumber) seek SectionUtility
command "vpop" (paramOptional paramNumber) seek SectionMetaData
"switch back to previous view"]
seek :: CommandSeek

View file

@ -20,7 +20,7 @@ import Logs.View
def :: [Command]
def = [notBareRepo $ notDirect $
command "view" paramView seek SectionUtility "enter a view branch"]
command "view" paramView seek SectionMetaData "enter a view branch"]
seek :: CommandSeek
seek = withWords start

View file

@ -66,6 +66,7 @@ data CommandSection
| SectionSetup
| SectionMaintenance
| SectionQuery
| SectionMetaData
| SectionUtility
| SectionPlumbing
deriving (Eq, Ord, Enum, Bounded)
@ -75,5 +76,6 @@ descSection SectionCommon = "Commonly used commands"
descSection SectionSetup = "Repository setup commands"
descSection SectionMaintenance = "Repository maintenance commands"
descSection SectionQuery = "Query commands"
descSection SectionMetaData = "Metadata commands"
descSection SectionUtility = "Utility commands"
descSection SectionPlumbing = "Plumbing commands"

View file

@ -313,39 +313,6 @@ subdirectories).
from a remote computer.
Note that this does not yet use HTTPS for security, so use with caution!
* `view [field=value ...] [tag ...]`
Uses metadata to build a view branch of the files in the current branch,
and checks out the view branch. Only files in the current branch whose
metadata matches all the specified field values and tags will be
shown in the view.
Multiple values for a metadata field can be specified, either by using
a glob (field="\*") or by listing each wanted value. The resulting view
will put files in subdirectories according to the value of their fields.
Once within a view, you can make additional subdirectories, and
copy or move files into them. When you commit, the metadata will
be updated to correspond to your changes.
* `vpop [N]`
Switches from the currently active view back to the previous view.
Or, from the first view back to original branch.
The optional number tells how many views to pop.
* `vadd [field=value ...] [tag ...]`
Refines the currently checked out view branch, adding additional fields
or tags.
* `vcycle`
When a view involves nested subdirectories, this cycles the order.
For example, when the view has date/author/tag, vcycle will switch
it to author/tag/date.
# REPOSITORY SETUP COMMANDS
* `init [description]`
@ -726,7 +693,7 @@ subdirectories).
Note that this subcommand can be used to graph any git repository; it
is not limited to git-annex repositories.
# UTILITY COMMANDS
# METADATA COMMANDS
* `metadata [path ...] [-s field=value -s field+=value -s field-=value ...]`
@ -745,6 +712,41 @@ subdirectories).
git annex metadata annexscreencast.ogv -s tag+=video -s tag+=screencast
* `view [field=value ...] [tag ...]`
Uses metadata to build a view branch of the files in the current branch,
and checks out the view branch. Only files in the current branch whose
metadata matches all the specified field values and tags will be
shown in the view.
Multiple values for a metadata field can be specified, either by using
a glob (field="\*") or by listing each wanted value. The resulting view
will put files in subdirectories according to the value of their fields.
Once within a view, you can make additional subdirectories, and
copy or move files into them. When you commit, the metadata will
be updated to correspond to your changes.
* `vpop [N]`
Switches from the currently active view back to the previous view.
Or, from the first view back to original branch.
The optional number tells how many views to pop.
* `vadd [field=value ...] [tag ...]`
Refines the currently checked out view branch, adding additional fields
or tags.
* `vcycle`
When a view involves nested subdirectories, this cycles the order.
For example, when the view has date/author/tag, vcycle will switch
it to author/tag/date.
# UTILITY COMMANDS
* `migrate [path ...]`
Changes the specified annexed files to use the default key-value backend