.. _locking:

===================================
Kallithea repository locking system
===================================


The scenario for repos with `locking function` enabled is that
every initial clone and every pull gives users (with write permission)
the exclusive right to do a push.

Each repo can be manually unlocked by an admin from the repo settings menu.

| Repos with **locking function=disabled** is the default, that's how repos work
  today.
| Repos with **locking function=enabled** behaves like follows:

Repos have a state called ``locked`` that can be true or false.
The hg/git commands ``hg/git clone``, ``hg/git pull``, and ``hg/git push``
influence this state:

- The command ``hg/git pull <repo>`` will lock that repo (``locked=true``)
  if the user has write/admin permissions on this repo

- The command ``hg/git clone <repo>`` will lock that repo (``locked=true``) if the
  user has write/admin permissions on this repo


Kallithea will remember the user who locked the repo so
only this specific user can unlock the repo (``locked=false``) by calling

- ``hg/git push <repo>``

Every other command on that repo from this user and
every command from any other user will result in an http return code 423 (locked).

Additionally, the http error includes the <user> that locked the repo
(e.g., “repository <repo> locked by user <user>”).