comparison hgext/acl.py @ 9052:1344e607180b

acl: wrapped docstrings at 78 characters

9051:f8e25885d975

# GNU General Public License version 2, incorporated herein by reference.
#

'''hooks for controlling repository access

This hook makes it possible to allow or deny write access to portions
of a repository when receiving incoming changesets.

The authorization is matched based on the local user name on the
system where the hook runs, and not the committer of the original
changeset (since the latter is merely informative).

The acl hook is best used along with a restricted shell like hgsh,
preventing authenticating users from doing anything other than
pushing or pulling. The hook is not safe to use if users have
interactive shell access, as they can then disable the hook.
Nor is it safe if remote users share an account, because then there
is no way to distinguish them.

To use this hook, configure the acl extension in your hgrc like this:

  [extensions]
  hgext.acl =

  [acl]
  # Check whether the source of incoming changes is in this list
  # ("serve" == ssh or http, "push", "pull", "bundle")
  sources = serve

The allow and deny sections take a subtree pattern as key (with a
glob syntax by default), and a comma separated list of users as
the corresponding value. The deny list is checked before the allow
list is.

  [acl.allow]
  # If acl.allow is not present, all users are allowed by default.
  # An empty acl.allow section means no users allowed.
  docs/** = doc_writer

9052:1344e607180b

# GNU General Public License version 2, incorporated herein by reference.
#

'''hooks for controlling repository access

This hook makes it possible to allow or deny write access to portions of a
repository when receiving incoming changesets.

The authorization is matched based on the local user name on the system where
the hook runs, and not the committer of the original changeset (since the
latter is merely informative).

The acl hook is best used along with a restricted shell like hgsh, preventing
authenticating users from doing anything other than pushing or pulling. The
hook is not safe to use if users have interactive shell access, as they can
then disable the hook. Nor is it safe if remote users share an account,
because then there is no way to distinguish them.

To use this hook, configure the acl extension in your hgrc like this:

  [extensions]
  hgext.acl =

  [acl]
  # Check whether the source of incoming changes is in this list
  # ("serve" == ssh or http, "push", "pull", "bundle")
  sources = serve

The allow and deny sections take a subtree pattern as key (with a glob syntax
by default), and a comma separated list of users as the corresponding value.
The deny list is checked before the allow list is.

  [acl.allow]
  # If acl.allow is not present, all users are allowed by default.
  # An empty acl.allow section means no users allowed.
  docs/** = doc_writer