diff --git a/docs/usage/locking.rst b/docs/usage/locking.rst --- a/docs/usage/locking.rst +++ b/docs/usage/locking.rst @@ -5,6 +5,12 @@ 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 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: @@ -20,22 +26,13 @@ influence this state: user has write/admin permissions on this repo -Kallithea will remember the user id who locked the repo +Kallithea will remember the user id who locked the repo so only this specific user can unlock the repo (locked=false) by calling - `hg/git push ` -every other command on that repo from this user and -every command from any other user will result in http return code 423 (locked) - - -additionally the http error includes the that locked the repo -(e.g. “repository locked by user ”) +Every other command on that repo from this user and +every command from any other user will result in http return code 423 (locked). - -So the scenario of use 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 admin from the repo settings menu. +Additionally, the http error includes the that locked the repo +(e.g. “repository locked by user ”).