Darcs.Arguments

Documentation

data DarcsFlag

The DarcsFlag type is a list of all flags that can ever be passed to darcs, or to one of its commands.

Constructors

Help

ListOptions

NoTest

Test

OnlyChangesToFiles

ChangesToAllFiles

LeaveTestDir

NoLeaveTestDir

Timings

Debug

DebugVerbose

DebugHTTP

Verbose

NormalVerbosity

Quiet

Target String

Cc String

Output AbsolutePathOrStd

OutputAutoName AbsolutePath

Subject String

InReplyTo String

SendmailCmd String

Author String

PatchName String

OnePatch String

SeveralPatch String

AfterPatch String

UpToPatch String

TagName String

LastN Int

MaxCount Int

PatchIndexRange Int Int

NumberPatches

OneTag String

AfterTag String

UpToTag String

Context AbsolutePath

Count

LogFile AbsolutePath

RmLogFile

DontRmLogFile

DistName String

All

Recursive

NoRecursive

Reorder

RestrictPaths

DontRestrictPaths

AskDeps

NoAskDeps

IgnoreTimes

DontIgnoreTimes

LookForAdds

NoLookForAdds

AnyOrder

CreatorHash String

Intersection

Union

Complement

Sign

SignAs String

NoSign

SignSSL String

HappyForwarding

NoHappyForwarding

Verify AbsolutePath

VerifySSL AbsolutePath

SSHControlMaster

NoSSHControlMaster

RemoteDarcs String

EditDescription

NoEditDescription

Toks String

EditLongComment

NoEditLongComment

PromptLongComment

KeepDate

NoKeepDate

AllowConflicts

MarkConflicts

NoAllowConflicts

SkipConflicts

Boring

SkipBoring

AllowCaseOnly

DontAllowCaseOnly

AllowWindowsReserved

DontAllowWindowsReserved

DontGrabDeps

DontPromptForDependencies

PromptForDependencies

Compress

NoCompress

UnCompress

WorkRepoDir String

WorkRepoUrl String

RemoteRepo String

NewRepo String

Reply String

ApplyAs String

MachineReadable

HumanReadable

Pipe

Interactive

DiffCmd String

ExternalMerge String

Summary

NoSummary

Unified

NonUnified

Reverse

Forward

Partial

Complete

Lazy

Ephemeral

FixFilePath AbsolutePath AbsolutePath

DiffFlags String

XMLOutput

ForceReplace

OnePattern PatchMatch

SeveralPattern PatchMatch

AfterPattern PatchMatch

UpToPattern PatchMatch

NonApply

NonVerify

NonForce

DryRun

SetDefault Bool

NoSetDefault Bool

FancyMoveAdd

NoFancyMoveAdd

Disable

SetScriptsExecutable

DontSetScriptsExecutable

Bisect

UseHashedInventory

UseOldFashionedInventory

UseFormat2

PristinePlain

PristineNone

NoUpdateWorking

Sibling AbsolutePath

Relink

RelinkPristine

NoLinks

OptimizePristine

OptimizeHTTP

UpgradeFormat

Files

NoFiles

Directories

NoDirectories

Pending

NoPending

PosthookCmd String

NoPosthook

AskPosthook

RunPosthook

PrehookCmd String

NoPrehook

AskPrehook

RunPrehook

UMask String

StoreInMemory

ApplyOnDisk

NoHTTPPipelining

NoCache

AllowUnrelatedRepos

Check

Repair

JustThisRepo

NullFlag

Instances

Eq DarcsFlag

Show DarcsFlag

flagToString :: [DarcsOption] -> DarcsFlag -> Maybe String

applyDefaults :: [DarcsOption] -> [DarcsFlag] -> [DarcsFlag]

nubOptions :: [DarcsOption] -> [DarcsFlag] -> [DarcsFlag]

maxCount :: [DarcsFlag] -> Maybe Int

isin :: DarcsAtomicOption -> [DarcsFlag] -> Bool

arein :: DarcsOption -> [DarcsFlag] -> Bool

definePatches :: RepoPatch p => FL (PatchInfoAnd p) -> IO ()

defineChanges :: Patchy p => p -> IO ()

fixFilePathOrStd :: [DarcsFlag] -> FilePath -> IO AbsolutePathOrStd

fixUrl :: [DarcsFlag] -> String -> IO String

fixUrlFlag :: [DarcsFlag] -> DarcsFlag -> IO DarcsFlag

fixSubPaths :: [DarcsFlag] -> [FilePath] -> IO [SubPath]

fixSubPaths files returns the SubPaths for the paths in files that are inside the repository, preserving their order. Paths in files that are outside the repository directory are not in the result.

When converting a relative path to an absolute one, this function first tries to interpret the relative path with respect to the current working directory. If that fails, it tries to interpret it with respect to the repository directory. Only when that fails does it omit the path from the result.

It is intended for validating file arguments to darcs commands.

areFileArgs :: [SubPath] -> Bool

data DarcsAtomicOption

A type for darcs' options. The value contains the command line switch(es) for the option, a help string, and a function to build a DarcsFlag from the command line arguments. for each constructor, shortSwitches represents the list of short command line switches which invoke the option, longSwitches the list of long command line switches, optDescr the description of the option, and argDescr the description of its argument, if any. mkFlag is a function which makes a DarcsFlag from the arguments of the option.

Constructors

DarcsArgOption [Char] [String] (String -> DarcsFlag) String String

DarcsArgOption shortSwitches longSwitches mkFlag ArgDescr OptDescr The constructor for options with a string argument, such as --tag

DarcsAbsPathOption [Char] [String] (AbsolutePath -> DarcsFlag) String String

DarcsAbsPathOption shortSwitches longSwitches mkFlag ArgDescr OptDescr The constructor for options with an absolute path argument, such as --sibling

DarcsAbsPathOrStdOption [Char] [String] (AbsolutePathOrStd -> DarcsFlag) String String

DarcsAbsPathOrStdOption shortSwitches longSwitches mkFlag ArgDescr OptDescr The constructor for options with a path argument, such as -o

DarcsOptAbsPathOption [Char] [String] String (AbsolutePath -> DarcsFlag) String String

DarcsOptAbsPathOrStdOption shortSwitches longSwitches defaultPath mkFlag ArgDescr OptDescr where defaultPath is a default value for the Path, as a string to be parsed as if it had been given on the command line. The constructor for options with an optional path argument, such as -O

DarcsNoArgOption [Char] [String] DarcsFlag String

DarcsNoArgOption shortSwitches longSwitches mkFlag optDescr The constructon fon options with no arguments.

DarcsInternalOption DarcsFlag

DarcsInternalOption An option just for internal use (e.g. defaulting), not directly available to the user.

atomicOptions :: DarcsOption -> [DarcsAtomicOption]

data DarcsOption

Constructors

DarcsSingleOption DarcsAtomicOption

DarcsMultipleChoiceOption [DarcsAtomicOption]

A constructor for grouping related options together, such as --hashed, --darcs-2 and --old-fashioned-inventory.

DarcsMutuallyExclusive [DarcsAtomicOption] ([DarcsFlag] -> [DarcsFlag])

optionFromDarcsOption :: AbsolutePath -> DarcsOption -> [OptDescr DarcsFlag]

help :: DarcsOption

listOptions :: DarcsOption

list_option is an option which lists the command's arguments

listFiles :: IO [String]

Get a list of all non-boring files and directories in the working copy.

anyVerbosity :: [DarcsOption]

disable :: DarcsOption

restrictPaths :: DarcsOption

notest :: DarcsOption

test :: DarcsOption

workingRepoDir :: DarcsOption

remoteRepo :: DarcsOption

remoteRepo is the option used to specify the URL of the remote repository to work with

leaveTestDir :: DarcsOption

possiblyRemoteRepoDir :: DarcsOption

getRepourl :: [DarcsFlag] -> Maybe String

getRepourl takes a list of flags and returns the url of the repository specified by Repodir "directory" in that list of flags, if any. This flag is present if darcs was invoked with --repodir=DIRECTORY

listRegisteredFiles :: IO [String]

listRegisteredFiles returns the list of all registered files in the repository.

listUnregisteredFiles :: IO [String]

listUnregisteredFiles returns the list of all non-boring unregistered files in the repository.

author :: DarcsOption

getAuthor :: [DarcsFlag] -> IO String

getAuthor takes a list of flags and returns the author of the change specified by Author "Leo Tolstoy" in that list of flags, if any. Otherwise, if Pipe is present, asks the user who is the author and returns the answer. If neither are present, try to guess the author, from _darcs/prefs, and if it's not possible, ask the user.

getEasyAuthor :: IO (Maybe String)

getEasyAuthor tries to get the author name first from the repository preferences, then from global preferences, then from environment variables. Returns Nothing if it could not get it.

getSendmailCmd :: [DarcsFlag] -> IO String

getSendmailCmd takes a list of flags and returns the sendmail command to be used by darcs send. Looks for a command specified by SendmailCmd "command" in that list of flags, if any. This flag is present if darcs was invoked with --sendmail-command=COMMAND Alternatively the user can set $SENDMAIL which will be used as a fallback if present.

fileHelpAuthor :: [String]

environmentHelpEmail :: ([String], [String])

patchnameOption :: DarcsOption

distnameOption :: DarcsOption

logfile :: DarcsOption

rmlogfile :: DarcsOption

fromOpt :: DarcsOption

subject :: DarcsOption

getSubject :: [DarcsFlag] -> Maybe String

getSubject takes a list of flags and returns the subject of the mail to be sent by darcs send. Looks for a subject specified by Subject "subject" in that list of flags, if any. This flag is present if darcs was invoked with --subject=SUBJECT

inReplyTo :: DarcsOption

getInReplyTo :: [DarcsFlag] -> Maybe String

target :: DarcsOption

ccSend :: DarcsOption

ccApply :: DarcsOption

getCc :: [DarcsFlag] -> String

getCc takes a list of flags and returns the addresses to send a copy of the patch bundle to when using darcs send. looks for a cc address specified by Cc "address" in that list of flags. Returns the addresses as a comma separated string.

output :: DarcsOption

outputAutoName :: DarcsOption

recursive :: String -> DarcsOption

inventoryChoices :: DarcsOption

getInventoryChoices :: DarcsOption

upgradeFormat :: DarcsOption

askdeps :: DarcsOption

ignoretimes :: DarcsOption

lookforadds :: DarcsOption

askLongComment :: DarcsOption

keepDate :: DarcsOption

sendmailCmd :: DarcsOption

environmentHelpSendmail :: ([String], [String])

sign :: DarcsOption

verify :: DarcsOption

editDescription :: DarcsOption

reponame :: DarcsOption

creatorhash :: DarcsOption

applyConflictOptions :: DarcsOption

reply :: DarcsOption

pullConflictOptions :: DarcsOption

useExternalMerge :: DarcsOption

depsSel :: DarcsOption

nocompress :: DarcsOption

uncompressNocompress :: DarcsOption

repoCombinator :: DarcsOption

optionsLatex :: [DarcsOption] -> String

reorderPatches :: DarcsOption

noskipBoring :: DarcsOption

allowProblematicFilenames :: DarcsOption

applyas :: DarcsOption

humanReadable :: DarcsOption

changesReverse :: DarcsOption

onlyToFiles :: DarcsOption

changesFormat :: DarcsOption

matchOneContext :: DarcsOption

matchOneNontag :: DarcsOption

matchMaxcount :: DarcsOption

sendToContext :: DarcsOption

getContext :: [DarcsFlag] -> Maybe AbsolutePath

getContext takes a list of flags and returns the context specified by Context c in that list of flags, if any. This flag is present if darcs was invoked with --context=FILE

pipeInteractive :: DarcsOption

allInteractive :: DarcsOption

allPipeInteractive :: DarcsOption

summary :: DarcsOption

unified :: DarcsOption

tokens :: DarcsOption

partial :: DarcsOption

partialCheck :: DarcsOption

diffCmdFlag :: DarcsOption

diffflags :: DarcsOption

unidiff :: DarcsOption

xmloutput :: DarcsOption

forceReplace :: DarcsOption

dryRun :: [DarcsOption]

dryRunNoxml :: DarcsOption

printDryRunMessageAndExit :: RepoPatch p => String -> [DarcsFlag] -> FL (PatchInfoAnd p) -> IO ()

printDryRunMessageAndExit action opts patches prints a string representing the action that would be taken if the --dry-run option had not been passed to darcs. Then darcs exits successfully. action is the name of the action being taken, like "push" opts is the list of flags which were sent to darcs patches is the sequence of patches which would be touched by action.

showFriendly :: Patchy p => [DarcsFlag] -> p -> Doc

showFriendly flags patch returns a Doc representing the right way to show patch given the list flags of flags darcs was invoked with.

matchOne :: DarcsOption

matchSeveral :: DarcsOption

matchRange :: DarcsOption

matchSeveralOrRange :: DarcsOption

happyForwarding :: DarcsOption

matchSeveralOrLast :: DarcsOption

setDefault :: Bool -> DarcsOption

fancyMoveAdd :: DarcsOption

setScriptsExecutableOption :: DarcsOption

bisect :: DarcsOption

sibling :: DarcsOption

flagsToSiblings :: [DarcsFlag] -> [AbsolutePath]

flagsToSiblings collects the contents of all Sibling flags in a list of flags.

relink :: DarcsOption

relinkPristine :: DarcsOption

nolinks :: DarcsOption

files :: DarcsOption

directories :: DarcsOption

pending :: DarcsOption

posthookCmd :: DarcsOption

posthookPrompt :: DarcsOption

getPosthookCmd :: [DarcsFlag] -> Maybe String

getPosthookCmd takes a list of flags and returns the posthook command specified by PosthookCmd a in that list of flags, if any.

prehookCmd :: DarcsOption

prehookPrompt :: DarcsOption

getPrehookCmd :: [DarcsFlag] -> Maybe String

getPrehookCmd takes a list of flags and returns the prehook command specified by PrehookCmd a in that list of flags, if any.

nullFlag :: DarcsOption

umaskOption :: DarcsOption

storeInMemory :: DarcsOption

patchSelectFlag :: DarcsFlag -> Bool

patchSelectFlag f holds whenever f is a way of selecting patches such as PatchName n.

networkOptions :: [DarcsOption]

noCache :: DarcsOption

allowUnrelatedRepos :: DarcsOption

checkOrRepair :: DarcsOption

justThisRepo :: DarcsOption

optimizePristine :: DarcsOption

optimizeHTTP :: DarcsOption

getOutput :: [DarcsFlag] -> FilePath -> Maybe AbsolutePathOrStd