Index

type index

A git index

Using

generic (open-index object)

Returns an index object for OBJECT (a repository)

Specializers:
(common-lisp:string)
(common-lisp:pathname)
(repository)

macro (with-index (var &optional repository-or-path) &body body)

Load an index from a repository, path or if none is specified then an in-memory index is used. The newly opened index is bound to the variable VAR.

Parameters:
var -- the symbol the opened index will be bound to.
repository-or-path -- the repository or path to open the index from.
body -- the body of the macro.

Adding

generic (index-add-file path index)

Adds the PATH to the INDEX.

Parameters:
path -- the relative path of a file to be added to the repository.
Specializers:
(common-lisp:string index)
(common-lisp:pathname index)
(common-lisp:list index)

State

generic (index-conflicts-p index)

Specializers:
(index)

These functions assist management of the state of the in memory copy of the index.

generic index-reload

generic (index-write index)

Write the INDEX back to the file system.

Specializers:
(index)

Clearing

generic (index-clear index)

Clear contents of the INDEX removing all entries. Changes need to be written back to disk to take effect.

Specializers:
(index)

Convert to Tree

generic (index-to-tree index)

Write the current index to a new tree object.

Specializers:
(index)