Mercurial > kallithea
diff docs/usage/locking.rst @ 5425:5ae8e644aa88
docs: spelling, grammar, content and typography
author | Søren Løvborg <sorenl@unity3d.com> |
---|---|
date | Tue, 18 Aug 2015 11:47:19 +0200 |
parents | 8d065db04909 |
children |
line wrap: on
line diff
--- a/docs/usage/locking.rst Fri Aug 14 17:21:26 2015 +0200 +++ b/docs/usage/locking.rst Tue Aug 18 11:47:19 2015 +0200 @@ -4,24 +4,24 @@ Repository locking ================== -Kallithea has a ``repository locking`` feature, disabled by default. When +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. -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``, +When repository locking is enabled, repositories get a ``locked`` flag. +The hg/git commands ``hg/git clone``, ``hg/git pull``, and ``hg/git push`` influence this state: -- A ``clone`` or ``pull`` action on the repository locks it (``locked=true``) +- A ``clone`` or ``pull`` action locks the target repository if the user has write/admin permissions on this repository. - Kallithea will remember the user who locked the repository so only this - specific user can unlock the repo (``locked=false``) by performing a ``push`` + specific user can unlock the repo by performing a ``push`` command. - 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 + Additionally, the HTTP error will mention the user that locked the repository (e.g., “repository <repo> locked by user <user>”). Each repository can be manually unlocked by an administrator from the