# HG changeset patch
# User Thomas De Schampheleire <thomas.de.schampheleire@gmail.com>
# Date 1428261564 -7200
# Node ID 8d065db049099d238735ed3592feca730fc834fb
# Parent  b52a1ccee927ebadb2b3667fedb33b756e86ff0e
docs/usage: rework section 'repository locking'

diff -r b52a1ccee927 -r 8d065db04909 docs/usage/locking.rst
--- a/docs/usage/locking.rst	Sun Apr 05 21:05:12 2015 +0200
+++ b/docs/usage/locking.rst	Sun Apr 05 21:19:24 2015 +0200
@@ -1,38 +1,28 @@
 .. _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.