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

Darcs.Arguments

Synopsis

Documentation

data DarcsFlag Source

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 
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 
NoSetDefault 
FancyMoveAdd 
NoFancyMoveAdd 
Disable 
SetScriptsExecutable 
DontSetScriptsExecutable 
UseHashedInventory 
UseOldFashionedInventory 
UseFormat2 
PristinePlain 
PristineNone 
NoUpdateWorking 
Sibling AbsolutePath 
Relink 
RelinkPristine 
NoLinks 
OptimizePristine 
UpgradeFormat 
Files 
NoFiles 
Directories 
NoDirectories 
Pending 
NoPending 
PosthookCmd String 
NoPosthook 
AskPosthook 
RunPosthook 
PrehookCmd String 
NoPrehook 
AskPrehook 
RunPrehook 
UMask String 
StoreInMemory 
ApplyOnDisk 
HTTPPipelining 
NoHTTPPipelining 
NoCache 
AllowUnrelatedRepos 
Check 
Repair 
JustThisRepo 
NullFlag 

data DarcsOption Source

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.

DarcsMultipleChoiceOption [DarcsOption]

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

listOptions :: DarcsOptionSource

list_option is an option which lists the command's arguments

listFiles :: IO [String]Source

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

remoteRepo :: DarcsOptionSource

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

getRepourl :: [DarcsFlag] -> Maybe StringSource

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]Source

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

listUnregisteredFiles :: IO [String]Source

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

getAuthor :: [DarcsFlag] -> IO StringSource

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)Source

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 StringSource

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.

getSubject :: [DarcsFlag] -> Maybe StringSource

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

getCc :: [DarcsFlag] -> StringSource

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.

getContext :: [DarcsFlag] -> Maybe AbsolutePathSource

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

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

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 -> DocSource

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

flagsToSiblings :: [DarcsFlag] -> [AbsolutePath]Source

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

getPosthookCmd :: [DarcsFlag] -> Maybe StringSource

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

getPrehookCmd :: [DarcsFlag] -> Maybe StringSource

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

patchSelectFlag :: DarcsFlag -> BoolSource

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