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

Darcs.Repository.Internal

Synopsis

Documentation

data Repository p Source

Constructors

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

Instances

data RepoType p Source

Instances

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.

Instances

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

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.

type PatchSet p = RL (RL (PatchInfoAnd p))Source

A PatchSet is in reverse order, plus has information about which tags are clean, meaning all patches applied prior to them are in the tag itself, so we can stop reading at that point. Just to clarify, the first patch in a PatchSet is the one most recently applied to the repo.

PatchSets have the property that if (info $ last $ head a) == (info $ last $ head b) then (tail a) and (tail b) are identical repositories

Questions:

Does this mean that in a patch set such as [[a b t1 c d e t2][f g t3] [h i]], t1, t2 and t3 are tags, and t2 and t3 are clean?

Can we have PatchSet with length at least 3? Florent

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.