darcs-2.1.99.0: a distributed, interactive, smart revision control system Source code Contents Index

Darcs.Arguments

Synopsis

data DarcsFlag = Help | ListOptions | NoTest | Test | HelpOnMatch | OnlyChangesToFiles | 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 | PatchIndexRange Int Int | NumberPatches | OneTag String | AfterTag String | UpToTag String | Context AbsolutePath | Count | LogFile AbsolutePath | RmLogFile | DistName String | All | Recursive | NoRecursive | Reorder | RestrictPaths | DontRestrictPaths | AskDeps | NoAskDeps | IgnoreTimes | LookForAdds | NoLookForAdds | AnyOrder | CreatorHash String | Intersection | Union | Complement | Sign | SignAs String | NoSign | SignSSL String | HappyForwarding | Verify AbsolutePath | VerifySSL AbsolutePath | SSHControlMaster | NoSSHControlMaster | EditDescription | NoEditDescription | Toks String | EditLongComment | NoEditLongComment | PromptLongComment | AllowConflicts | MarkConflicts | NoAllowConflicts | Boring | AllowCaseOnly | AllowWindowsReserved | 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 | Reverse | CheckPoint | 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 | Files | NoFiles | Directories | NoDirectories | Pending | NoPending | PosthookCmd String | NoPosthook | AskPosthook | RunPosthook | PrehookCmd String | NoPrehook | AskPrehook | RunPrehook | UMask String | StoreInMemory | HTTPPipelining | NoHTTPPipelining | NoCache | AllowUnrelatedRepos | NullFlag flagToString :: [DarcsOption] -> DarcsFlag -> Maybe String isin :: (String -> DarcsFlag) -> [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 fixSubPaths :: [DarcsFlag] -> [FilePath] -> IO [SubPath] areFileArgs :: [SubPath] -> Bool data DarcsOption = DarcsArgOption [Char] [String] (String -> DarcsFlag) String String | DarcsAbsPathOption [Char] [String] (AbsolutePath -> DarcsFlag) String String | DarcsAbsPathOrStdOption [Char] [String] (AbsolutePathOrStd -> DarcsFlag) String String | DarcsOptAbsPathOption [Char] [String] String (AbsolutePath -> DarcsFlag) String String | DarcsNoArgOption [Char] [String] DarcsFlag String | DarcsMultipleChoiceOption [DarcsOption] option_from_darcsoption :: AbsolutePath -> DarcsOption -> [OptDescr DarcsFlag] help :: DarcsOption list_options :: DarcsOption list_files :: IO [String] help_on_match :: DarcsOption any_verbosity :: [DarcsOption] disable :: DarcsOption notest :: DarcsOption test :: DarcsOption working_repo_dir :: DarcsOption testByDefault :: [DarcsFlag] -> [DarcsFlag] remote_repo :: DarcsOption leave_test_dir :: DarcsOption possibly_remote_repo_dir :: DarcsOption get_repourl :: [DarcsFlag] -> Maybe String list_registered_files :: IO [String] list_unregistered_files :: IO [String] author :: DarcsOption get_author :: [DarcsFlag] -> IO String get_easy_author :: IO (Maybe String) get_sendmail_cmd :: [DarcsFlag] -> IO String patchname_option :: DarcsOption distname_option :: DarcsOption logfile :: DarcsOption rmlogfile :: DarcsOption from_opt :: DarcsOption subject :: DarcsOption get_subject :: [DarcsFlag] -> Maybe String in_reply_to :: DarcsOption get_in_reply_to :: [DarcsFlag] -> Maybe String target :: DarcsOption cc :: DarcsOption get_cc :: [DarcsFlag] -> String output :: DarcsOption output_auto_name :: DarcsOption recursive :: String -> DarcsOption inventory_choices :: DarcsOption get_inventory_choices :: DarcsOption askdeps :: DarcsOption ignoretimes :: DarcsOption lookforadds :: DarcsOption ask_long_comment :: DarcsOption sendmail_cmd :: DarcsOption sign :: DarcsOption verify :: DarcsOption edit_description :: DarcsOption reponame :: DarcsOption tagname :: DarcsOption creatorhash :: DarcsOption apply_conflict_options :: DarcsOption reply :: DarcsOption pull_conflict_options :: DarcsOption use_external_merge :: DarcsOption deps_sel :: DarcsOption nocompress :: DarcsOption uncompress_nocompress :: DarcsOption repo_combinator :: DarcsOption options_latex :: [DarcsOption] -> String reorder_patches :: DarcsOption noskip_boring :: DarcsOption allow_problematic_filenames :: DarcsOption applyas :: DarcsOption human_readable :: DarcsOption changes_reverse :: DarcsOption only_to_files :: DarcsOption changes_format :: DarcsOption match_one_context :: DarcsOption match_one_nontag :: DarcsOption send_to_context :: DarcsOption get_context :: [DarcsFlag] -> Maybe AbsolutePath pipe_interactive :: DarcsOption all_interactive :: DarcsOption all_pipe_interactive :: DarcsOption summary :: DarcsOption unified :: DarcsOption tokens :: DarcsOption checkpoint :: DarcsOption partial :: DarcsOption partial_check :: DarcsOption diff_cmd_flag :: DarcsOption diffflags :: DarcsOption unidiff :: DarcsOption xmloutput :: DarcsOption force_replace :: DarcsOption dry_run :: [DarcsOption] dry_run_noxml :: DarcsOption print_dry_run_message_and_exit :: RepoPatch p => String -> [DarcsFlag] -> FL (PatchInfoAnd p) -> IO () showFriendly :: Patchy p => [DarcsFlag] -> p -> Doc match_one :: DarcsOption match_several :: DarcsOption match_range :: DarcsOption match_several_or_range :: DarcsOption happy_forwarding :: DarcsOption match_several_or_last :: DarcsOption set_default :: DarcsOption fancy_move_add :: DarcsOption set_scripts_executable :: DarcsOption sibling :: DarcsOption flagsToSiblings :: [DarcsFlag] -> [AbsolutePath] relink :: DarcsOption relink_pristine :: DarcsOption nolinks :: DarcsOption files :: DarcsOption directories :: DarcsOption pending :: DarcsOption posthook_cmd :: DarcsOption posthook_prompt :: DarcsOption get_posthook_cmd :: [DarcsFlag] -> Maybe String prehook_cmd :: DarcsOption prehook_prompt :: DarcsOption get_prehook_cmd :: [DarcsFlag] -> Maybe String nullFlag :: DarcsOption umask_option :: DarcsOption store_in_memory :: DarcsOption patch_select_flag :: DarcsFlag -> Bool network_options :: [DarcsOption] allow_unrelated_repos :: DarcsOption

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 HelpOnMatch OnlyChangesToFiles 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 PatchIndexRange Int Int NumberPatches OneTag String AfterTag String UpToTag String Context AbsolutePath Count LogFile AbsolutePath RmLogFile DistName String All Recursive NoRecursive Reorder RestrictPaths DontRestrictPaths AskDeps NoAskDeps IgnoreTimes LookForAdds NoLookForAdds AnyOrder CreatorHash String Intersection Union Complement Sign SignAs String NoSign SignSSL String HappyForwarding Verify AbsolutePath VerifySSL AbsolutePath SSHControlMaster NoSSHControlMaster EditDescription NoEditDescription Toks String EditLongComment NoEditLongComment PromptLongComment AllowConflicts MarkConflicts NoAllowConflicts Boring AllowCaseOnly AllowWindowsReserved 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 Reverse CheckPoint 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 Files NoFiles Directories NoDirectories Pending NoPending PosthookCmd String NoPosthook AskPosthook RunPosthook PrehookCmd String NoPrehook AskPrehook RunPrehook UMask String StoreInMemory HTTPPipelining NoHTTPPipelining NoCache AllowUnrelatedRepos NullFlag Instances Eq DarcsFlag Show DarcsFlag

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

isin :: (String -> DarcsFlag) -> [DarcsFlag] -> Bool Source

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

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

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

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

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

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

areFileArgs :: [SubPath] -> Bool Source

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.

option_from_darcsoption :: AbsolutePath -> DarcsOption -> [OptDescr DarcsFlag] Source

help :: DarcsOption Source

list_options :: DarcsOption Source

list_option is an option which lists the command's arguments

list_files :: IO [String] Source

list_files returns the list of all non-boring files in the repository

help_on_match :: DarcsOption Source

any_verbosity :: [DarcsOption] Source

disable :: DarcsOption Source

notest :: DarcsOption Source

test :: DarcsOption Source

working_repo_dir :: DarcsOption Source

testByDefault :: [DarcsFlag] -> [DarcsFlag] Source

remote_repo :: DarcsOption Source

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

leave_test_dir :: DarcsOption Source

possibly_remote_repo_dir :: DarcsOption Source

get_repourl :: [DarcsFlag] -> Maybe String Source

get_repourl 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

list_registered_files :: IO [String] Source

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

list_unregistered_files :: IO [String] Source

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

author :: DarcsOption Source

get_author :: [DarcsFlag] -> IO String Source

get_author 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.

get_easy_author :: IO (Maybe String) Source

get_easy_author 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.

get_sendmail_cmd :: [DarcsFlag] -> IO String Source

get_sendmail_cmd 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.

patchname_option :: DarcsOption Source

distname_option :: DarcsOption Source

logfile :: DarcsOption Source

rmlogfile :: DarcsOption Source

from_opt :: DarcsOption Source

subject :: DarcsOption Source

get_subject :: [DarcsFlag] -> Maybe String Source

get_subject 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

in_reply_to :: DarcsOption Source

get_in_reply_to :: [DarcsFlag] -> Maybe String Source

target :: DarcsOption Source

cc :: DarcsOption Source

get_cc :: [DarcsFlag] -> String Source

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

output_auto_name :: DarcsOption Source

recursive :: String -> DarcsOption Source

inventory_choices :: DarcsOption Source

get_inventory_choices :: DarcsOption Source

askdeps :: DarcsOption Source

ignoretimes :: DarcsOption Source

lookforadds :: DarcsOption Source

ask_long_comment :: DarcsOption Source

sendmail_cmd :: DarcsOption Source

sign :: DarcsOption Source

verify :: DarcsOption Source

edit_description :: DarcsOption Source

reponame :: DarcsOption Source

tagname :: DarcsOption Source

creatorhash :: DarcsOption Source

apply_conflict_options :: DarcsOption Source

reply :: DarcsOption Source

pull_conflict_options :: DarcsOption Source

use_external_merge :: DarcsOption Source

deps_sel :: DarcsOption Source

nocompress :: DarcsOption Source

uncompress_nocompress :: DarcsOption Source

repo_combinator :: DarcsOption Source

options_latex :: [DarcsOption] -> String Source

reorder_patches :: DarcsOption Source

noskip_boring :: DarcsOption Source

allow_problematic_filenames :: DarcsOption Source

applyas :: DarcsOption Source

human_readable :: DarcsOption Source

changes_reverse :: DarcsOption Source

only_to_files :: DarcsOption Source

changes_format :: DarcsOption Source

match_one_context :: DarcsOption Source

match_one_nontag :: DarcsOption Source

send_to_context :: DarcsOption Source

get_context :: [DarcsFlag] -> Maybe AbsolutePath Source

get_context 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

pipe_interactive :: DarcsOption Source

all_interactive :: DarcsOption Source

all_pipe_interactive :: DarcsOption Source

summary :: DarcsOption Source

unified :: DarcsOption Source

tokens :: DarcsOption Source

checkpoint :: DarcsOption Source

partial :: DarcsOption Source

partial_check :: DarcsOption Source

diff_cmd_flag :: DarcsOption Source

diffflags :: DarcsOption Source

unidiff :: DarcsOption Source

xmloutput :: DarcsOption Source

force_replace :: DarcsOption Source

dry_run :: [DarcsOption] Source

dry_run_noxml :: DarcsOption Source

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

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

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

match_one :: DarcsOption Source

match_several :: DarcsOption Source

match_range :: DarcsOption Source

match_several_or_range :: DarcsOption Source

happy_forwarding :: DarcsOption Source

match_several_or_last :: DarcsOption Source

set_default :: DarcsOption Source

fancy_move_add :: DarcsOption Source

set_scripts_executable :: DarcsOption Source

sibling :: DarcsOption Source

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

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

relink :: DarcsOption Source

relink_pristine :: DarcsOption Source

nolinks :: DarcsOption Source

files :: DarcsOption Source

directories :: DarcsOption Source

pending :: DarcsOption Source

posthook_cmd :: DarcsOption Source

posthook_prompt :: DarcsOption Source

get_posthook_cmd :: [DarcsFlag] -> Maybe String Source

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

prehook_cmd :: DarcsOption Source

prehook_prompt :: DarcsOption Source

get_prehook_cmd :: [DarcsFlag] -> Maybe String Source

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

nullFlag :: DarcsOption Source

umask_option :: DarcsOption Source

store_in_memory :: DarcsOption Source

patch_select_flag :: DarcsFlag -> Bool Source

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

network_options :: [DarcsOption] Source

allow_unrelated_repos :: DarcsOption Source

Produced by Haddock version 2.4.2