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




data Repository p Source


Repo !String ![DarcsFlag] !RepoFormat !(RepoType p) 


data RepoType p Source


data RIO p a Source

Repository IO monad. This monad-like datatype is responsible for sequencing IO actions that modify the tentative recorded state of the repository.


Monad (RIO p)

We have an instance of Monad so that IO actions that do not change the tentative recorded state are convenient in the IO monad.

Functor (RIO p) 

($-) :: ((forall p. RepoPatch p => Repository p -> IO a) -> IO a) -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource

maybeIdentifyRepository :: [DarcsFlag] -> String -> IO (IdentifyRepo p)Source

Tries to identify the repository in a given directory

identifyDarcsRepository :: forall p. [DarcsFlag] -> String -> IO (Repository p)Source

identifyDarcsRepository identifies the repo at url. Warning: you have to know what kind of patches are found in that repo.

identifyRepositoryFor :: forall p. RepoPatch p => Repository p -> String -> IO (Repository p)Source

identifyRepositoryFor repo url identifies (and returns) the repo at url, but fails if it is not compatible for reading from and writing to.

data IdentifyRepo p Source

The status of a given directory: is it a darcs repository?


BadRepository String

looks like a repository with some error

NonRepository String

safest guess

GoodRepository (Repository p) 

setTentativePending :: forall p. RepoPatch p => Repository p -> FL Prim -> IO ()Source

setTentativePending is basically unsafe. It overwrites the pending state with a new one, not related to the repository state.

withRecorded :: RepoPatch p => Repository p -> ((AbsolutePath -> IO a) -> IO a) -> (AbsolutePath -> IO a) -> IO aSource

withRepoLock :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource

withRepoReadLock :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource

withRepository :: [DarcsFlag] -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource

withRepositoryDirectory :: forall a. [DarcsFlag] -> String -> (forall p. RepoPatch p => Repository p -> IO a) -> IO aSource

tentativelyAddToPending :: forall p. RepoPatch p => Repository p -> [DarcsFlag] -> FL Prim -> IO ()Source

This fuction is unsafe because it accepts a patch that works on the tentative pending and we don't currently track the state of the tentative pending.

optimizeInventory :: RepoPatch p => Repository p -> IO ()Source

Writes out a fresh copy of the inventory that minimizes the amount of inventory that need be downloaded when people pull from the repository.

Specifically, it breaks up the inventory on the most recent tag. This speeds up most commands when run remotely, both because a smaller file needs to be transfered (only the most recent inventory). It also gives a guarantee that all the patches prior to a given tag are included in that tag, so less commutation and history traversal is needed. This latter issue can become very important in large repositories.

setScriptsExecutable :: IO ()Source

Sets scripts in or below the current directory executable. A script is any file that starts with the bytes '#!'. This is used sometimes for --set-scripts-executable, but at other times --set-scripts-executable is handled by the hunk patch case of applyFL.

getRepository :: RIO p (Repository p)Source

Similar to the ask function of the MonadReader class. This allows actions in the RIO monad to get the current repository. FIXME: Don't export this. If we don't export this it makes it harder for arbitrary IO actions to access the repository and hence our code is easier to audit.

rIO :: IO a -> RIO p aSource

This the RIO equivalent of liftIO.