kallithea Files · docs/usage/locking.rst

Files @ f6076c096692

Branch filter:

Location: kallithea/docs/usage/locking.rst

f6076c096692 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

tests: vcs: remove influence of user's hg settings

Certain settings in the user's hgrc file can cause test failures. For
example, enabling a non-existent extension prints stderr messages like

*** failed to import extension journal: No module named journal

Tests that check stderr output for emptiness, like
test_clone_hg_repo_by_admin, then fail.

Instead, avoid all influence of the user's settings, by setting HGRCPATH and
HGPLAIN to empty.

In versions of Mercurial before 4.2, setting an empty HGRCPATH was generally
enough to get expected behavior, but since 4.2 the behavior of some commands
has changed, and a pager is now default. Setting HGPLAIN is a simple way of
neutralizing even that.

.. _locking:

==================
Repository locking
==================

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`` flag.
The hg/git commands ``hg/git clone``, ``hg/git pull``,
and ``hg/git push`` influence this state:

- 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 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 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
repository settings menu.