darcs-2.14.1: 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 #

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 #

Minimal complete definition

yes

Methods

yes :: a -> Bool #

no :: a -> Bool #

Instances
YesNo WithWorkingDir # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WantGuiPause # 
Instance details

Defined in Darcs.UI.Options.All

YesNo UseIndex # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: UseIndex -> Bool #

no :: UseIndex -> Bool #

YesNo LeaveTestDir # 
Instance details

Defined in Darcs.UI.Options.All

YesNo SetScriptsExecutable # 
Instance details

Defined in Darcs.UI.Options.All

YesNo RunTest # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: RunTest -> Bool #

no :: RunTest -> Bool #

YesNo IncludeBoring # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LookForMoves # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LookForReplaces # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LookForAdds # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: LookForAdds -> Bool #

no :: LookForAdds -> Bool #

YesNo DryRun # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: DryRun -> Bool #

no :: DryRun -> Bool #

YesNo UseCache # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: UseCache -> Bool #

no :: UseCache -> Bool #

YesNo Reorder # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: Reorder -> Bool #

no :: Reorder -> Bool #

YesNo WithPatchIndex # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Compression # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: Compression -> Bool #

no :: Compression -> Bool #

YesNo Summary # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: Summary -> Bool #

no :: Summary -> Bool #

YesNo WithContext # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: WithContext -> Bool #

no :: WithContext -> Bool #

YesNo XmlOutput # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: XmlOutput -> Bool #

no :: XmlOutput -> Bool #

YesNo EnumPatches # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: EnumPatches -> Bool #

no :: EnumPatches -> Bool #

data RootAction #

Options for darcs iself that act like sub-commands.

Instances
Eq RootAction # 
Instance details

Defined in Darcs.UI.Options.All

Show RootAction # 
Instance details

Defined in Darcs.UI.Options.All

data StdCmdAction #

Constructors

Help 
ListOptions 
Disable 
Instances
Eq StdCmdAction # 
Instance details

Defined in Darcs.UI.Options.All

Show StdCmdAction # 
Instance details

Defined in Darcs.UI.Options.All

data Verbosity #

Constructors

Quiet 
NormalVerbosity 
Verbose 
Instances
Eq Verbosity # 
Instance details

Defined in Darcs.Repository.Flags

Show Verbosity # 
Instance details

Defined in Darcs.Repository.Flags

data HooksConfig #

Constructors

HooksConfig 

Fields

data HookConfig #

Constructors

HookConfig 

Fields

data UseCache #

Constructors

YesUseCache 
NoUseCache 
Instances
Eq UseCache # 
Instance details

Defined in Darcs.Repository.Flags

Show UseCache # 
Instance details

Defined in Darcs.Repository.Flags

YesNo UseCache # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: UseCache -> Bool #

no :: UseCache -> Bool #

data XmlOutput #

Constructors

NoXml 
YesXml 
Instances
Eq XmlOutput # 
Instance details

Defined in Darcs.UI.Options.All

Show XmlOutput # 
Instance details

Defined in Darcs.UI.Options.All

YesNo XmlOutput # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: XmlOutput -> Bool #

no :: XmlOutput -> Bool #

data DryRun #

Constructors

YesDryRun 
NoDryRun 
Instances
Eq DryRun # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

Show DryRun # 
Instance details

Defined in Darcs.Repository.Flags

YesNo DryRun # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: DryRun -> Bool #

no :: DryRun -> Bool #

dryRun :: PrimDarcsOption DryRun #

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 WantGuiPause #

Instances
Eq WantGuiPause # 
Instance details

Defined in Darcs.Repository.Flags

Show WantGuiPause # 
Instance details

Defined in Darcs.Repository.Flags

YesNo WantGuiPause # 
Instance details

Defined in Darcs.UI.Options.All

data SelectDeps #

Constructors

NoDeps 
AutoDeps 
PromptDeps 
Instances
Eq SelectDeps # 
Instance details

Defined in Darcs.UI.Options.All

Show SelectDeps # 
Instance details

Defined in Darcs.UI.Options.All

maxCount :: PrimDarcsOption (Maybe Int) #

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 WorkRepo #

Instances
Eq WorkRepo # 
Instance details

Defined in Darcs.Repository.Flags

Show WorkRepo # 
Instance details

Defined in Darcs.Repository.Flags

data RemoteRepos #

Constructors

RemoteRepos [String] 
Instances
Eq RemoteRepos # 
Instance details

Defined in Darcs.Repository.Flags

Show RemoteRepos # 
Instance details

Defined in Darcs.Repository.Flags

reponame :: PrimDarcsOption (Maybe String) #

--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 SetDefault #

Instances
Eq SetDefault # 
Instance details

Defined in Darcs.Repository.Flags

Show SetDefault # 
Instance details

Defined in Darcs.Repository.Flags

data Logfile #

Constructors

Logfile 

data LookForAdds #

Instances
Eq LookForAdds # 
Instance details

Defined in Darcs.Repository.Flags

Show LookForAdds # 
Instance details

Defined in Darcs.Repository.Flags

YesNo LookForAdds # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: LookForAdds -> Bool #

no :: LookForAdds -> Bool #

data LookForMoves #

Instances
Eq LookForMoves # 
Instance details

Defined in Darcs.Repository.Flags

Show LookForMoves # 
Instance details

Defined in Darcs.Repository.Flags

YesNo LookForMoves # 
Instance details

Defined in Darcs.UI.Options.All

data UseIndex #

Constructors

UseIndex 
IgnoreIndex 
Instances
Eq UseIndex # 
Instance details

Defined in Darcs.Repository.Flags

Show UseIndex # 
Instance details

Defined in Darcs.Repository.Flags

YesNo UseIndex # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: UseIndex -> Bool #

no :: UseIndex -> Bool #

data ScanKnown #

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 # 
Instance details

Defined in Darcs.Repository.Flags

Show ScanKnown # 
Instance details

Defined in Darcs.Repository.Flags

onlyToFiles :: PrimDarcsOption Bool #

TODO: see issue2395

data DiffAlgorithm #

Constructors

PatienceDiff 
MyersDiff 
Instances
Eq DiffAlgorithm # 
Instance details

Defined in Darcs.Util.Diff

Show DiffAlgorithm # 
Instance details

Defined in Darcs.Util.Diff

data WithContext #

Constructors

NoContext 
YesContext 
Instances
Eq WithContext # 
Instance details

Defined in Darcs.UI.Options.All

Show WithContext # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithContext # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: WithContext -> Bool #

no :: WithContext -> Bool #

data ExternalDiff #

Constructors

ExternalDiff 
Instances
Eq ExternalDiff # 
Instance details

Defined in Darcs.UI.Options.All

Show ExternalDiff # 
Instance details

Defined in Darcs.UI.Options.All

data TestChanges #

Instances
Eq TestChanges # 
Instance details

Defined in Darcs.UI.Options.All

data RunTest #

Constructors

YesRunTest 
NoRunTest 
Instances
Eq RunTest # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

Show RunTest # 
Instance details

Defined in Darcs.Repository.Flags

YesNo RunTest # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: RunTest -> Bool #

no :: RunTest -> Bool #

data LeaveTestDir #

Instances
Eq LeaveTestDir # 
Instance details

Defined in Darcs.Repository.Flags

Show LeaveTestDir # 
Instance details

Defined in Darcs.Repository.Flags

YesNo LeaveTestDir # 
Instance details

Defined in Darcs.UI.Options.All

data Sign #

Instances
Eq Sign # 
Instance details

Defined in Darcs.UI.Options.All

Methods

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

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

Show Sign # 
Instance details

Defined in Darcs.UI.Options.All

Methods

showsPrec :: Int -> Sign -> ShowS #

show :: Sign -> String #

showList :: [Sign] -> ShowS #

data Verify #

Instances
Eq Verify # 
Instance details

Defined in Darcs.UI.Options.All

Methods

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

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

Show Verify # 
Instance details

Defined in Darcs.UI.Options.All

conflictsNo :: PrimDarcsOption (Maybe AllowConflicts) #

push, apply, rebase apply: default to NoAllowConflicts

data Compression #

Instances
Eq Compression # 
Instance details

Defined in Darcs.Repository.Flags

Show Compression # 
Instance details

Defined in Darcs.Repository.Flags

YesNo Compression # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: Compression -> Bool #

no :: Compression -> Bool #

data Reorder #

Constructors

NoReorder 
Reorder 
Instances
Eq Reorder # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

YesNo Reorder # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: Reorder -> Bool #

no :: Reorder -> Bool #

data Output #

Instances
Eq Output # 
Instance details

Defined in Darcs.UI.Options.All

Methods

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

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

Show Output # 
Instance details

Defined in Darcs.UI.Options.All

data Summary #

Constructors

NoSummary 
YesSummary 
Instances
Eq Summary # 
Instance details

Defined in Darcs.UI.Options.All

Methods

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

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

Show Summary # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Summary # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: Summary -> Bool #

no :: Summary -> Bool #

data NetworkOptions #

TODO: reconsider this grouping of options

data UMask #

Constructors

YesUMask String 
NoUMask 
Instances
Eq UMask # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

Show UMask # 
Instance details

Defined in Darcs.Repository.Flags

Methods

showsPrec :: Int -> UMask -> ShowS #

show :: UMask -> String #

showList :: [UMask] -> ShowS #

data CloneKind #

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 # 
Instance details

Defined in Darcs.Repository.Flags

Show CloneKind # 
Instance details

Defined in Darcs.Repository.Flags

data PatchFormat #

Constructors

PatchFormat1 
PatchFormat2 
Instances
Eq PatchFormat # 
Instance details

Defined in Darcs.Repository.Flags

Show PatchFormat # 
Instance details

Defined in Darcs.Repository.Flags

hashed :: PrimDarcsOption () #

Deprecated flag, still present to output an error message.

data TestStrategy #

Constructors

Once 
Linear 
Backoff 
Bisect 
Instances
Eq TestStrategy # 
Instance details

Defined in Darcs.UI.Options.All

Show TestStrategy # 
Instance details

Defined in Darcs.UI.Options.All

data EnumPatches #

Instances
Eq EnumPatches # 
Instance details

Defined in Darcs.UI.Options.All

Show EnumPatches # 
Instance details

Defined in Darcs.UI.Options.All

YesNo EnumPatches # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: EnumPatches -> Bool #

no :: EnumPatches -> Bool #

data GzcrcsAction #

Constructors

GzcrcsCheck 
GzcrcsRepair 
Instances
Eq GzcrcsAction # 
Instance details

Defined in Darcs.UI.Options.All

Show GzcrcsAction # 
Instance details

Defined in Darcs.UI.Options.All