mirrors/git-annex
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
git-annex/Option.hs

80 lines
2.3 KiB
Haskell
Raw Normal View History

refactoring and cleanup No code changes.
2011-10-30 03:48:46 +00:00
{- git-annex command-line options
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
-
refactoring and cleanup No code changes.
2011-10-30 03:48:46 +00:00
- Copyright 2010-2011 Joey Hess <joey@kitenet.net>
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
-
- Licensed under the GNU GPL version 3 or higher.
-}
tweak
2012-01-06 14:14:37 +00:00
module Option (
common,
matcher,
flag,
field,
name,
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
ArgDescr(..),
OptDescr(..),
) where
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
import System.Console.GetOpt
Add --debug option. Closes: #627499 This takes advantage of the debug logging done by missingh, and I added my own debug messages for executeFile calls. There are still some other low-level ways git-annex runs stuff that are not shown by debugging, but this gets most of it easily.
2011-05-21 15:52:13 +00:00
import System.Log.Logger
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
rename
2011-10-05 20:02:51 +00:00
import Common.Annex
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
import qualified Annex
add --and --or --not -( and -) I dislike -( and -), but without using a different option parser, can't easily use bare parens. --and and --or will become more useful once there are more interesting limits than --exclude
2011-09-18 22:21:42 +00:00
import Limit
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
import Usage
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
tweak
2012-01-06 14:14:37 +00:00
common :: [Option]
common =
Clear up short option confusion between --from and --force (-f is now --from, and there is no short option for --force).
2011-04-03 16:18:38 +00:00
[ Option [] ["force"] (NoArg (setforce True))
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
"allow actions that may lose annexed data"
fast mode Add --fast flag, that can enable less expensive, but also less thurough versions of some commands. * Add --fast flag, that can enable less expensive, but also less thurough versions of some commands. * fsck: In fast mode, avoid checking checksums. * unused: In fast mode, just show all existing temp files as unused, and avoid expensive scan for other unused content.
2011-03-22 21:41:06 +00:00
, Option ['F'] ["fast"] (NoArg (setfast True))
"avoid slow operations"
remove optimize subcommand; use --auto instead get, drop: Added --auto option, which decides whether to get/drop content as needed to work toward the configured numcopies. The problem with bundling it up in optimize was that I then found I wanted to run an optmize that did not drop files, only got them. Considered adding a --only-get switch to it, but that seemed wrong. Instead, let's make existing subcommands optionally smarter. Note that the only actual difference between drop and drop --auto is that the latter does not even try to drop a file if it knows of not enough copies, and does not print any error messages about files it was unable to drop. It might be nice to make get avoid asking git for attributes when not in auto mode. For now it always asks for attributes.
2011-09-15 17:30:04 +00:00
, Option ['a'] ["auto"] (NoArg (setauto True))
"automatic mode"
generalize quiet flag to output type This will allow adding other styles of output.
2011-09-01 17:35:07 +00:00
, Option ['q'] ["quiet"] (NoArg (setoutput Annex.QuietOutput))
add git-annex-shell command This is not yet complete, as it does not allow starting rsync or scp.
2010-12-30 20:52:24 +00:00
"avoid verbose output"
generalize quiet flag to output type This will allow adding other styles of output.
2011-09-01 17:35:07 +00:00
, Option ['v'] ["verbose"] (NoArg (setoutput Annex.NormalOutput))
Add --debug option. Closes: #627499 This takes advantage of the debug logging done by missingh, and I added my own debug messages for executeFile calls. There are still some other low-level ways git-annex runs stuff that are not shown by debugging, but this gets most of it easily.
2011-05-21 15:52:13 +00:00
"allow verbose output (default)"
basic json support This includes a generic JSONStream library built on top of Text.JSON (somewhat hackishly). It would be possible to stream out a single json document describing all actions, but it's probably better for consumers if they can expect one json document per line, so I did it that way instead. Output from external programs used for transferring files is not currently hidden when outputting json, which probably makes it not very useful there. This may be dealt with if there is demand for json output for --get or --move to be parsable. The version, status, and find subcommands have hand-crafted output and don't do json. The whereis subcommand needs to be modified to produce useful json.
2011-09-01 19:16:31 +00:00
, Option ['j'] ["json"] (NoArg (setoutput Annex.JSONOutput))
"enable JSON output"
Add --debug option. Closes: #627499 This takes advantage of the debug logging done by missingh, and I added my own debug messages for executeFile calls. There are still some other low-level ways git-annex runs stuff that are not shown by debugging, but this gets most of it easily.
2011-05-21 15:52:13 +00:00
, Option ['d'] ["debug"] (NoArg (setdebug))
"show debug messages"
--backend now overrides any backend configured in .gitattributes files.
2011-05-18 23:34:46 +00:00
, Option ['b'] ["backend"] (ReqArg setforcebackend paramName)
"specify key-value backend to use"
git-annex-shell is complete still not used
2010-12-31 17:39:30 +00:00
]
rework config storage Moved away from a map of flags to storing config directly in the AnnexState structure. Got rid of most accessor functions in Annex. This allowed supporting multiple --exclude flags.
2011-01-26 04:17:38 +00:00
where
setforce v = Annex.changeState $ \s -> s { Annex.force = v }
fast mode Add --fast flag, that can enable less expensive, but also less thurough versions of some commands. * Add --fast flag, that can enable less expensive, but also less thurough versions of some commands. * fsck: In fast mode, avoid checking checksums. * unused: In fast mode, just show all existing temp files as unused, and avoid expensive scan for other unused content.
2011-03-22 21:41:06 +00:00
setfast v = Annex.changeState $ \s -> s { Annex.fast = v }
remove optimize subcommand; use --auto instead get, drop: Added --auto option, which decides whether to get/drop content as needed to work toward the configured numcopies. The problem with bundling it up in optimize was that I then found I wanted to run an optmize that did not drop files, only got them. Considered adding a --only-get switch to it, but that seemed wrong. Instead, let's make existing subcommands optionally smarter. Note that the only actual difference between drop and drop --auto is that the latter does not even try to drop a file if it knows of not enough copies, and does not print any error messages about files it was unable to drop. It might be nice to make get avoid asking git for attributes when not in auto mode. For now it always asks for attributes.
2011-09-15 17:30:04 +00:00
setauto v = Annex.changeState $ \s -> s { Annex.auto = v }
generalize quiet flag to output type This will allow adding other styles of output.
2011-09-01 17:35:07 +00:00
setoutput v = Annex.changeState $ \s -> s { Annex.output = v }
--backend now overrides any backend configured in .gitattributes files.
2011-05-18 23:34:46 +00:00
setforcebackend v = Annex.changeState $ \s -> s { Annex.forcebackend = Just v }
clarify
2011-05-22 23:07:20 +00:00
setdebug = liftIO $ updateGlobalLogger rootLoggerName $
setLevel DEBUG
tweak
2012-01-06 14:14:37 +00:00
matcher :: [Option]
matcher =
add --and --or --not -( and -) I dislike -( and -), but without using a different option parser, can't easily use bare parens. --and and --or will become more useful once there are more interesting limits than --exclude
2011-09-18 22:21:42 +00:00
[ longopt "not" "negate next option"
, longopt "and" "both previous and next option must match"
, longopt "or" "either previous or next option must match"
, shortopt "(" "open group of options"
, shortopt ")" "close group of options"
]
where
go go gadget hlint
2011-09-21 03:24:48 +00:00
longopt o = Option [] [o] $ NoArg $ addToken o
shortopt o = Option o [] $ NoArg $ addToken o
refactoring and cleanup No code changes.
2011-10-30 03:48:46 +00:00
more command-specific options Made --from and --to command-specific options. Added generic storage for values of command-specific options, which allows removing some of the special case fields in AnnexState. (Also added generic storage for command-specific flags, although there are not yet any.) Note that this storage uses a Map, so repeatedly looking up the same value is slightly more expensive than looking up an AnnexState field. But, the value can be looked up once in the seek stage, transformed as necessary, and passed in a closure to the start stage, and this avoids that overhead. Still, I'm hesitant to use this for things like force or fast flags. It's probably best to reserve it for flags that are only used by a few commands, or options like --from and --to that it's important only be allowed to be used with commands that implement them, to avoid user confusion.
2012-01-06 07:06:25 +00:00
{- An option that sets a flag. -}
tweak
2012-01-06 14:14:37 +00:00
flag :: String -> String -> String -> Option
flag short opt description =
Option short [opt] (NoArg (Annex.setFlag opt)) description
per-command options Finally commands can define their own options. Moved --format and --print0 to be options only of find.
2012-01-06 02:48:59 +00:00
more command-specific options Made --from and --to command-specific options. Added generic storage for values of command-specific options, which allows removing some of the special case fields in AnnexState. (Also added generic storage for command-specific flags, although there are not yet any.) Note that this storage uses a Map, so repeatedly looking up the same value is slightly more expensive than looking up an AnnexState field. But, the value can be looked up once in the seek stage, transformed as necessary, and passed in a closure to the start stage, and this avoids that overhead. Still, I'm hesitant to use this for things like force or fast flags. It's probably best to reserve it for flags that are only used by a few commands, or options like --from and --to that it's important only be allowed to be used with commands that implement them, to avoid user confusion.
2012-01-06 07:06:25 +00:00
{- An option that sets a field. -}
tweak
2012-01-06 14:14:37 +00:00
field :: String -> String -> String -> String -> Option
field short opt paramdesc description =
Option short [opt] (ReqArg (Annex.setField opt) paramdesc) description
{- The flag or field name used for an option. -}
name :: Option -> String
name (Option _ o _ _) = Prelude.head o
Reference in a new issue Copy permalink