darcs-2.18.2: a distributed, interactive, smart revision control system
Safe HaskellSafe-Inferred
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.

class YesNo a where Source #

Minimal complete definition

yes

Methods

yes :: a -> Bool Source #

no :: a -> Bool Source #

Instances

Instances details
YesNo DryRun Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

yes :: DryRun -> Bool Source #

no :: DryRun -> Bool Source #

YesNo InheritDefault Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LeaveTestDir Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo LookForAdds 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 Reorder Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo RunTest Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo SetScriptsExecutable Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo UseCache Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo UseIndex Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WantGuiPause Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithPatchIndex Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithPrefsTemplates Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithWorkingDir Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Compression Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo EnumPatches Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithSummary Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

data RootAction Source #

Options for darcs iself that act like sub-commands.

Instances

Instances details
Show RootAction Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq RootAction Source # 
Instance details

Defined in Darcs.UI.Options.All

data StdCmdAction Source #

Constructors

Help 
ListOptions 
Disable 

Instances

Instances details
Show StdCmdAction Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq StdCmdAction Source # 
Instance details

Defined in Darcs.UI.Options.All

data Verbosity Source #

Constructors

Quiet 
NormalVerbosity 
Verbose 

Instances

Instances details
Show Verbosity Source # 
Instance details

Defined in Darcs.Repository.Flags

Eq 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

Instances details
Show UseCache Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo UseCache Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq UseCache Source # 
Instance details

Defined in Darcs.Repository.Flags

data XmlOutput Source #

Constructors

NoXml 
YesXml 

Instances

Instances details
Show XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq XmlOutput Source # 
Instance details

Defined in Darcs.UI.Options.All

data DryRun Source #

Constructors

YesDryRun 
NoDryRun 

Instances

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

Eq DryRun Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

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

Instances

Instances details
Show WantGuiPause Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo WantGuiPause Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq WantGuiPause Source # 
Instance details

Defined in Darcs.Repository.Flags

data SelectDeps Source #

Constructors

NoDeps 
AutoDeps 
PromptDeps 

Instances

Instances details
Show SelectDeps Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq SelectDeps Source # 
Instance details

Defined in Darcs.UI.Options.All

newRepo :: PrimDarcsOption (Maybe String) Source #

This option is for when a new repo gets created. Used for clone, convert import, convert darcs-2, and initialize. For clone and initialize it has the same effect as giving the name as a normal argument.

The --repodir alias is there for compatibility, should be removed eventually.

TODO We need a way to deprecate options / option names.

data SetDefault Source #

Instances

Instances details
Show SetDefault Source # 
Instance details

Defined in Darcs.Repository.Flags

Eq SetDefault Source # 
Instance details

Defined in Darcs.Repository.Flags

data Logfile Source #

Constructors

Logfile 

data UseIndex Source #

Constructors

UseIndex 
IgnoreIndex 

Instances

Instances details
Show UseIndex Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo UseIndex Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq UseIndex Source # 
Instance details

Defined in Darcs.Repository.Flags

data LookForAdds Source #

Instances

Instances details
Show LookForAdds Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo LookForAdds Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq LookForAdds Source # 
Instance details

Defined in Darcs.Repository.Flags

data LookForMoves Source #

Instances

Instances details
Show LookForMoves Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo LookForMoves Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq LookForMoves Source # 
Instance details

Defined in Darcs.Repository.Flags

onlyToFiles :: PrimDarcsOption Bool Source #

TODO: see issue2395

data DiffAlgorithm Source #

Constructors

PatienceDiff 
MyersDiff 

Instances

Instances details
Show DiffAlgorithm Source # 
Instance details

Defined in Darcs.Util.Diff

Eq DiffAlgorithm Source # 
Instance details

Defined in Darcs.Util.Diff

data WithContext Source #

Constructors

NoContext 
YesContext 

Instances

Instances details
Show WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq WithContext Source # 
Instance details

Defined in Darcs.UI.Options.All

data ExternalDiff Source #

Instances

Instances details
Show ExternalDiff Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq ExternalDiff Source # 
Instance details

Defined in Darcs.UI.Options.All

data TestChanges Source #

Instances

Instances details
Eq TestChanges Source # 
Instance details

Defined in Darcs.UI.Options.All

data RunTest Source #

Constructors

YesRunTest 
NoRunTest 

Instances

Instances details
Show RunTest Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo RunTest Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq RunTest Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

data LeaveTestDir Source #

Instances

Instances details
Show LeaveTestDir Source # 
Instance details

Defined in Darcs.Repository.Flags

YesNo LeaveTestDir Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq LeaveTestDir Source # 
Instance details

Defined in Darcs.Repository.Flags

data Sign Source #

Instances

Instances details
Show Sign Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

showsPrec :: Int -> Sign -> ShowS #

show :: Sign -> String #

showList :: [Sign] -> ShowS #

Eq Sign Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

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

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

data Verify Source #

Instances

Instances details
Show Verify Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq Verify Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

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

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

conflictsNo :: PrimDarcsOption (Maybe AllowConflicts) Source #

push, apply, rebase apply: default to NoAllowConflicts

reorder :: PrimDarcsOption Reorder Source #

pull, apply, rebase pull, rebase apply

reorderPush :: PrimDarcsOption Reorder Source #

push; same as reorder but with help descriptions swapped

data Compression Source #

Instances

Instances details
Show Compression Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo Compression Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq Compression Source # 
Instance details

Defined in Darcs.UI.Options.All

data Reorder Source #

Constructors

NoReorder 
Reorder 

Instances

Instances details
YesNo Reorder Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq Reorder Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

data OptimizeDeep Source #

Instances

Instances details
Show OptimizeDeep Source # 
Instance details

Defined in Darcs.Repository.Flags

Eq OptimizeDeep Source # 
Instance details

Defined in Darcs.Repository.Flags

data Output Source #

Instances

Instances details
Show Output Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq Output Source # 
Instance details

Defined in Darcs.UI.Options.All

Methods

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

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

data WithSummary Source #

Constructors

NoSummary 
YesSummary 

Instances

Instances details
Show WithSummary Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo WithSummary Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq WithSummary Source # 
Instance details

Defined in Darcs.UI.Options.All

data RemoteDarcs Source #

Instances

Instances details
Show RemoteDarcs Source # 
Instance details

Defined in Darcs.Repository.Flags

Eq RemoteDarcs Source # 
Instance details

Defined in Darcs.Repository.Flags

data UMask Source #

Constructors

YesUMask String 
NoUMask 

Instances

Instances details
Show UMask Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

showsPrec :: Int -> UMask -> ShowS #

show :: UMask -> String #

showList :: [UMask] -> ShowS #

Eq UMask Source # 
Instance details

Defined in Darcs.Repository.Flags

Methods

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

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

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

Instances details
Show CloneKind Source # 
Instance details

Defined in Darcs.Repository.Flags

Eq CloneKind Source # 
Instance details

Defined in Darcs.Repository.Flags

data PatchFormat Source #

Instances

Instances details
Show PatchFormat Source # 
Instance details

Defined in Darcs.Repository.Flags

Eq PatchFormat Source # 
Instance details

Defined in Darcs.Repository.Flags

hashed :: PrimDarcsOption () Source #

Deprecated flag, still present to output an error message.

data TestStrategy Source #

Constructors

Once 
Linear 
Backoff 
Bisect 

Instances

Instances details
Show TestStrategy Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq TestStrategy Source # 
Instance details

Defined in Darcs.UI.Options.All

data EnumPatches Source #

Instances

Instances details
Show EnumPatches Source # 
Instance details

Defined in Darcs.UI.Options.All

YesNo EnumPatches Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq EnumPatches Source # 
Instance details

Defined in Darcs.UI.Options.All

data GzcrcsAction Source #

Constructors

GzcrcsCheck 
GzcrcsRepair 

Instances

Instances details
Show GzcrcsAction Source # 
Instance details

Defined in Darcs.UI.Options.All

Eq GzcrcsAction Source # 
Instance details

Defined in Darcs.UI.Options.All