kallithea Files · docs/usage/locking.rst

Files @ f2f7a8c1281e

Branch filter:

Location: kallithea/docs/usage/locking.rst

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

Thomas De Schampheleire

i18n: use TG2 compatible settings names i18n.lang and i18n.enabled

Following changes are made:
- Remove list of available translations: severely outdated and hard to
maintain.
- Replace lang with i18n.lang, reasons:
- Follow TurboGears2 conventions
- Align with 'i18n.enabled' which cannot be shortened
- Scoped settings provide grouping and are more clear
The old 'lang' is still recognized though, so no upgrade issue.
- Introduce/document i18n.enabled

Comments are intentionally kept concise in favor of the documentation.

.. _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.