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

Safe Haskell | None
Language | Haskell2010

Darcs.Repository.Prefs

Contents

- documentation of prefs files

Synopsis

- data Pref
  - = Author
  - | Binaries
  - | Boring
  - | Defaultrepo
  - | Defaults
  - | Email
  - | Motd
  - | Post
  - | Prefs
  - | Repos
  - | Sources
- addToPreflist :: Pref -> String -> IO ()
- deleteSources :: IO ()
- getPreflist :: Pref -> IO [String]
- setPreflist :: Pref -> [String] -> IO ()
- getGlobal :: Pref -> IO [String]
- environmentHelpHome :: ([String], [String])
- getDefaultRepo :: IO (Maybe String)
- addRepoSource :: String -> DryRun -> SetDefault -> InheritDefault -> Bool -> IO ()
- getPrefval :: String -> IO (Maybe String)
- setPrefval :: String -> String -> IO ()
- changePrefval :: String -> String -> String -> IO ()
- defPrefval :: String -> String -> IO String
- writeDefaultPrefs :: WithPrefsTemplates -> IO ()
- isBoring :: IO (FilePath -> Bool)
- data FileType
  - = BinaryFile
  - | TextFile
- filetypeFunction :: IO (FilePath -> FileType)
- getCaches :: UseCache -> Maybe AbsoluteOrRemotePath -> IO Cache
- globalCacheDir :: IO (Maybe FilePath)
- globalPrefsDirDoc :: String
- globalPrefsDir :: IO (Maybe FilePath)
- getMotd :: String -> IO ByteString
- showMotd :: String -> IO ()
- prefsUrl :: String -> Pref -> String
- prefsDirPath :: String
- prefsFilePath :: FilePath
- getPrefLines :: FilePath -> IO [String]
- prefsFilesHelp :: [(String, String)]

# Documentation

data Pref #

Constructors

Author |
Binaries |
Boring |
Defaultrepo |
Defaults |
Email |
Motd |
Post |
Prefs |
Repos |
Sources |

#### Instances

Instances details

Read Pref # |
Instance details Defined in Darcs.Repository.Prefs Methods readsPrec :: Int -> ReadS Pref # readList :: ReadS [Pref] # readPrec :: ReadPrec Pref # readListPrec :: ReadPrec [Pref] #
Show Pref # |
Instance details Defined in Darcs.Repository.Prefs Methods showsPrec :: Int -> Pref -> ShowS # show :: Pref -> String # showList :: [Pref] -> ShowS #
Eq Pref # |
Instance details Defined in Darcs.Repository.Prefs Methods (==) :: Pref -> Pref -> Bool # (/=) :: Pref -> Pref -> Bool #
Ord Pref # |
Instance details Defined in Darcs.Repository.Prefs Methods compare :: Pref -> Pref -> Ordering # (<) :: Pref -> Pref -> Bool # (<=) :: Pref -> Pref -> Bool # (>) :: Pref -> Pref -> Bool # (>=) :: Pref -> Pref -> Bool # max :: Pref -> Pref -> Pref # min :: Pref -> Pref -> Pref #

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

deleteSources :: IO () #

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

getPreflist :: Pref -> IO [String] #

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

getGlobal :: Pref -> IO [String] #

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

getDefaultRepo :: IO (Maybe String) #

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

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

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

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

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

writeDefaultPrefs :: WithPrefsTemplates -> IO () #

isBoring :: IO (FilePath -> Bool) #

data FileType #

Constructors

BinaryFile |
TextFile |

#### Instances

Instances details

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

filetypeFunction :: IO (FilePath -> FileType) #

getCaches :: UseCache -> Maybe AbsoluteOrRemotePath -> IO Cache #

globalCacheDir :: IO (Maybe FilePath) #

globalPrefsDirDoc :: String #

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

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

getMotd :: String -> IO ByteString #

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

showMotd :: String -> IO () #

Display the message of the day for a given repository,

prefsUrl :: String -> Pref -> String #

prefsDirPath :: String #

prefsFilePath :: FilePath #

getPrefLines :: FilePath -> IO [String] #

# documentation of prefs files

prefsFilesHelp :: [(String, String)] #