kallithea Changeset - 8d065db04909

Changeset - 8d065db04909

Parent rev.

Child rev.

[Not reviewed]

default

0 1 0

Thomas De Schampheleire - 11 years ago 2015-04-05 21:19:24
thomas.de.schampheleire@gmail.com

docs/usage: rework section 'repository locking'

1 file changed with 19 insertions and 29 deletions:

docs/usage/locking.rst

0 comments (0 inline, 0 general)

docs/usage/locking.rst

➞

Show inline comments

 .. _locking:
 ===================================
 Kallithea repository locking system
 ===================================
 ==================
 Repository locking
 ==================
 The scenario for repos with `locking function` enabled is that
 every initial clone and every pull gives users (with write permission)
 Kallithea has a ``repository locking`` feature, disabled by default. When
 enabled, 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:
 When repository locking is enabled, repositories get a ``locked`` state that
 can be true or false.  The hg/git commands ``hg/git clone``, ``hg/git pull``,
 and ``hg/git push`` influence this state:
 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
 - A ``clone`` or ``pull`` action on the repository locks it (``locked=true``)
   if the user has write/admin permissions on this repository.
 - 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
 - Kallithea will remember the user who locked the repository so only this
   specific user can unlock the repo (``locked=false``) by performing a ``push``
   command.
 - ``hg/git push <repo>``
 - Every other command on a locked repository 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 repository
   (e.g., “repository <repo> locked by user <user>”).
 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>”).
 Each repository can be manually unlocked by an administrator from the
 repository settings menu.

0 comments (0 inline, 0 general)