Safe Haskell	None
Language	Haskell2010

Darcs.Repository.Prefs

Contents

documentation of prefs files

Synopsis

addToPreflist :: String -> String -> IO ()
deleteSources :: IO ()
getPreflist :: String -> IO [String]
setPreflist :: String -> [String] -> IO ()
getGlobal :: String -> IO [String]
environmentHelpHome :: ([String], [String])
defaultrepo :: RemoteRepos -> AbsolutePath -> [String] -> IO [String]
getDefaultRepo :: IO (Maybe String)
addRepoSource :: String -> DryRun -> RemoteRepos -> SetDefault -> InheritDefault -> Bool -> IO ()
getPrefval :: String -> IO (Maybe String)
setPrefval :: String -> String -> IO ()
changePrefval :: String -> String -> String -> IO ()
defPrefval :: String -> String -> IO String
writeDefaultPrefs :: IO ()
boringRegexps :: IO [Regex]
isBoring :: IO (FilePath -> Bool)
data FileType
- = BinaryFile
- | TextFile
filetypeFunction :: IO (FilePath -> FileType)
getCaches :: UseCache -> String -> IO Cache
globalCacheDir :: IO (Maybe FilePath)
globalPrefsDirDoc :: String
globalPrefsDir :: IO (Maybe FilePath)
getMotd :: String -> IO ByteString
showMotd :: String -> IO ()
prefsUrl :: FilePath -> String
prefsDirPath :: FilePath
prefsFilePath :: FilePath
getPrefLines :: FilePath -> IO [String]
prefsFilesHelp :: [(String, String)]

Documentation

addToPreflist :: String -> String -> IO () Source #

deleteSources :: IO () Source #

delete references to other repositories. Used when cloning to a ssh destination. Assume the current working dir is the repository.

getPreflist :: String -> IO [String] Source #

setPreflist :: String -> [String] -> IO () Source #

getGlobal :: String -> IO [String] Source #

environmentHelpHome :: ([String], [String]) Source #

defaultrepo :: RemoteRepos -> AbsolutePath -> [String] -> IO [String] Source #

getDefaultRepo :: IO (Maybe String) Source #

addRepoSource :: String -> DryRun -> RemoteRepos -> SetDefault -> InheritDefault -> Bool -> IO () Source #

addRepoSource adds a new entry to _darcsprefsrepos and sets it as default in _darcsprefsdefaultrepo, unless --no-set-default or --dry-run is passed, or it is the same repository as the current one.

getPrefval :: String -> IO (Maybe String) Source #

setPrefval :: String -> String -> IO () Source #

changePrefval :: String -> String -> String -> IO () Source #

defPrefval :: String -> String -> IO String Source #

writeDefaultPrefs :: IO () Source #

boringRegexps :: IO [Regex] Source #

boringRegexps returns a list of the boring regexps, from the local and global prefs/boring files. Any invalid regexps are filtered, preventing an exception in (potentially) pure code, when the regexps are used.

isBoring :: IO (FilePath -> Bool) Source #

data FileType Source #

Constructors

BinaryFile
TextFile

Instances

Eq FileType Source #
Instance details Defined in Darcs.Repository.Prefs Methods (==) :: FileType -> FileType -> Bool # (/=) :: FileType -> FileType -> Bool #

filetypeFunction :: IO (FilePath -> FileType) Source #

getCaches :: UseCache -> String -> IO Cache Source #

globalCacheDir :: IO (Maybe FilePath) Source #

globalPrefsDirDoc :: String Source #

The relative path of the global preference directory; ~/.darcs on Unix, and %APPDATA%/darcs on Windows. This is used for online documentation.

globalPrefsDir :: IO (Maybe FilePath) Source #

The path of the global preference directory; ~/.darcs on Unix, and %APPDATA%/darcs on Windows.

getMotd :: String -> IO ByteString Source #

Fetch and return the message of the day for a given repository.

showMotd :: String -> IO () Source #

Display the message of the day for a given repository,

prefsUrl :: FilePath -> String Source #

prefsDirPath :: FilePath Source #

prefsFilePath :: FilePath Source #

getPrefLines :: FilePath -> IO [String] Source #

documentation of prefs files

prefsFilesHelp :: [(String, String)] Source #