darcs-2.14.4: a distributed, interactive, smart revision control system

Safe HaskellNone
LanguageHaskell2010

Darcs.UI.Options.All

Description

All the concrete options.

Notes:

  • The term "option" refers to a flag or combination of flags that together form a part of a command's configuration. Ideally, options should be orthogonal to each other, so we can freely combine them.
  • A primitive (indivisible) option has an associate value type.
  • An option named "xyzActions" represents a set of flags that act as mutually exclusive sub-commands. They typically have a dedicated value type named "XyzAction".
  • This module is probably best imported qualified. This is in contrast to the current practice of using subtly differing names to avoid name clashes for closely related items. For instance, the data constructors for an option's value type and the corresponding data constructors in DarcsFlag may coincide. This is also why we import Darcs.UI.Flags qualified here.
  • When the new options system is finally in place, no code other than the one for constructing options should directly refer to DarcsFlag constructors.
Synopsis

Documentation

type DarcsOption = OptSpec DarcsOptDescr Flag Source #

DarcsOption instantiates the first two type parameters of OptSpec to what we need in darcs. The first parameter is instantiated to The flag type is instantiate to Flag.

class YesNo a where Source #

Minimal complete definition

yes

Methods

yes :: a -> Bool Source #

no :: a -> Bool Source #

Instances
YesNo WithWorkingDir Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WantGuiPause Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo UseIndex Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LeaveTestDir Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo SetScriptsExecutable Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo RunTest Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo IncludeBoring Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LookForMoves Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LookForReplaces Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LookForAdds Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo DryRun Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: DryRun -> Bool Source #

no :: DryRun -> Bool Source #

YesNo UseCache Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Reorder Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithPatchIndex Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Compression Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Summary Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo EnumPatches Source # 
Instance details

Defined in Darcs.UI.Options.All

data RootAction Source #

Options for darcs iself that act like sub-commands.

Instances
Eq RootAction Source # 
Instance details

Defined in Darcs.UI.Options.All

Show RootAction Source # 
Instance details

Defined in Darcs.UI.Options.All

data Verbosity Source #

Constructors

Quiet 
NormalVerbosity 
Verbose 
Instances
Eq Verbosity Source # 
Instance details

Defined in Darcs.Repository.Flags

Show Verbosity Source # 
Instance details

Defined in Darcs.Repository.Flags

data HooksConfig Source #

Constructors

HooksConfig 

Fields

data HookConfig Source #

Constructors

HookConfig 

Fields

data UseCache Source #

Constructors

YesUseCache 
NoUseCache 
Instances
Eq UseCache Source # 
Instance details

Defined in Darcs.Repository.Flags

Show UseCache Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo UseCache Source # 
Instance details

Defined in Darcs.UI.Options.All

data XmlOutput Source #

Constructors

NoXml 
YesXml 
Instances
Eq XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

Show XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

data DryRun Source #

Constructors

YesDryRun 
NoDryRun 
Instances
Eq DryRun Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

(==) :: DryRun -> DryRun -> Bool #

(/=) :: DryRun -> DryRun -> Bool #

Show DryRun Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo DryRun Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: DryRun -> Bool Source #

no :: DryRun -> Bool Source #

dryRun :: PrimDarcsOption DryRun Source #

TODO someone wrote here long ago that any time --dry-run is a possibility automated users should be able to examine the results more easily with --xml. See also issue2397. dryRun w/o xml is currently used in add, pull, and repair.

data SelectDeps Source #

Constructors

NoDeps 
AutoDeps 
PromptDeps 
Instances
Eq SelectDeps Source # 
Instance details

Defined in Darcs.UI.Options.All

Show SelectDeps Source # 
Instance details

Defined in Darcs.UI.Options.All

maxCount :: PrimDarcsOption (Maybe Int) Source #

TODO: Returning -1 if the argument cannot be parsed as an integer is not something I expected to find in a Haskell program. Instead, the flag should take either a plain String argument (leaving it to a later stage to parse the String to an Int), or else a Maybe Int, taking the possibility of a failed parse into account.

data RemoteRepos Source #

Constructors

RemoteRepos [String] 
Instances
Eq RemoteRepos Source # 
Instance details

Defined in Darcs.Repository.Flags

Show RemoteRepos Source # 
Instance details

Defined in Darcs.Repository.Flags

reponame :: PrimDarcsOption (Maybe String) Source #

--repodir is there for compatibility, should be removed eventually

IMHO the whole option can disappear; it overlaps with using an extra (non-option) argument, which is how e.g. darcs get is usually invoked.

data Logfile Source #

Constructors

Logfile 

data UseIndex Source #

Constructors

UseIndex 
IgnoreIndex 
Instances
Eq UseIndex Source # 
Instance details

Defined in Darcs.Repository.Flags

Show UseIndex Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo UseIndex Source # 
Instance details

Defined in Darcs.UI.Options.All

data ScanKnown Source #

Constructors

ScanKnown

Just files already known to darcs

ScanAll

All files, i.e. look for new ones

ScanBoring

All files, even boring ones

Instances
Eq ScanKnown Source # 
Instance details

Defined in Darcs.Repository.Flags

Show ScanKnown Source # 
Instance details

Defined in Darcs.Repository.Flags

onlyToFiles :: PrimDarcsOption Bool Source #

TODO: see issue2395

data WithContext Source #

Constructors

NoContext 
YesContext 
Instances
Eq WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

Show WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

data RunTest Source #

Constructors

YesRunTest 
NoRunTest 
Instances
Eq RunTest Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

(==) :: RunTest -> RunTest -> Bool #

(/=) :: RunTest -> RunTest -> Bool #

Show RunTest Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo RunTest Source # 
Instance details

Defined in Darcs.UI.Options.All

data Sign Source #

Instances
Eq Sign Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

(==) :: Sign -> Sign -> Bool #

(/=) :: Sign -> Sign -> Bool #

Show Sign Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

showsPrec :: Int -> Sign -> ShowS #

show :: Sign -> String #

showList :: [Sign] -> ShowS #

data Verify Source #

Instances
Eq Verify Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

(==) :: Verify -> Verify -> Bool #

(/=) :: Verify -> Verify -> Bool #

Show Verify Source # 
Instance details

Defined in Darcs.UI.Options.All

conflictsNo :: PrimDarcsOption (Maybe AllowConflicts) Source #

push, apply, rebase apply: default to NoAllowConflicts

data Reorder Source #

Constructors

NoReorder 
Reorder 
Instances
Eq Reorder Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

(==) :: Reorder -> Reorder -> Bool #

(/=) :: Reorder -> Reorder -> Bool #

YesNo Reorder Source # 
Instance details

Defined in Darcs.UI.Options.All

data Output Source #

Instances
Eq Output Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

(==) :: Output -> Output -> Bool #

(/=) :: Output -> Output -> Bool #

Show Output Source # 
Instance details

Defined in Darcs.UI.Options.All

data Summary Source #

Constructors

NoSummary 
YesSummary 
Instances
Eq Summary Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

(==) :: Summary -> Summary -> Bool #

(/=) :: Summary -> Summary -> Bool #

Show Summary Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Summary Source # 
Instance details

Defined in Darcs.UI.Options.All

data NetworkOptions Source #

TODO: reconsider this grouping of options

data UMask Source #

Constructors

YesUMask String 
NoUMask 
Instances
Eq UMask Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

(==) :: UMask -> UMask -> Bool #

(/=) :: UMask -> UMask -> Bool #

Show UMask Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

showsPrec :: Int -> UMask -> ShowS #

show :: UMask -> String #

showList :: [UMask] -> ShowS #

data CloneKind Source #

Constructors

LazyClone

Just copy pristine and inventories

NormalClone

First do a lazy clone then copy everything

CompleteClone

Same as Normal but omit telling user they can interrumpt

Instances
Eq CloneKind Source # 
Instance details

Defined in Darcs.Repository.Flags

Show CloneKind Source # 
Instance details

Defined in Darcs.Repository.Flags

hashed :: PrimDarcsOption () Source #

Deprecated flag, still present to output an error message.