comparison doc/hgrc.5.txt @ 8727:1b713f72c91a

hgrc.5: language fixes

8726:72b95e3a0cc9

  by the path to the ".py" file (including the file name extension)
  that defines the extension.

  To explicitly disable an extension that is enabled in an hgrc of
  broader scope, prepend its path with '!', as in
  'hgext.foo = !/ext/path' or 'hgext.foo = !' when no path is
  supplied.

  Example for ~/.hgrc:

    [extensions]

    # do not use the site-wide hook
    incoming =
    incoming.email = /my/email/hook
    incoming.autobuild = /my/build/hook

  Most hooks are run with environment variables set that give added
  useful information. For each hook below, the environment
  variables it is passed are listed with names of the form
  "$HG_foo".

  changegroup;;
    Run after a changegroup has been added via push, pull or
    unbundle. ID of the first new changeset is in $HG_NODE. URL from
    which changes came is in $HG_URL.

    $HG_NODE. Name of tag is in $HG_TAG. Tag is local if
    $HG_LOCAL=1, in repo if $HG_LOCAL=0.
  update;;
    Run after updating the working directory. Changeset ID of first
    new parent is in $HG_PARENT1. If merge, ID of second new parent
    is in $HG_PARENT2. If update succeeded, $HG_ERROR=0. If update
    failed (e.g. because conflicts not resolved), $HG_ERROR=1.

  Note: it is generally better to use standard hooks rather
  than the generic pre- and post- command hooks as they are
  guaranteed to be called in the appropriate contexts for
  influencing transactions. Also, hooks like "commit" will be
  called in all contexts that generate a commit (eg. tag) and
  not just the commit command.

  Note2: Environment variables with empty values may not be
  passed to hooks on platforms like Windows. For instance,
  $HG_PARENT2 will not be available under Windows for non-merge
  changesets while being set to an empty value under Unix-like
  systems.

  The syntax for Python hooks is as follows:

    hookname = python:modulename.submodule.callable
    hookname = python:/path/to/python/module.py:callable

  Arguments listed as environment variables above are passed as
  keyword arguments, with no "HG_" prefix, and names in lower
  case.

  If a Python hook returns a "true" value or raises an
  exception, this is treated as failure of the hook.

[[http_proxy]]
http_proxy::
  Used to access web-based Mercurial repositories through a HTTP
  proxy.

      internal:merge;;
        use the internal non-interactive merge tool
      internal:fail;;
        fail to merge

    See the merge-tools section for more information on
    configuring tools.

  patch;;
    command to use to apply patches. Look for 'gpatch' or 'patch' in PATH if
    unset.
  quiet;;

8727:1b713f72c91a

  by the path to the ".py" file (including the file name extension)
  that defines the extension.

  To explicitly disable an extension that is enabled in an hgrc of
  broader scope, prepend its path with '!', as in
  'hgext.foo = !/ext/path' or 'hgext.foo = !' when path is not
  supplied.

  Example for ~/.hgrc:

    [extensions]

    # do not use the site-wide hook
    incoming =
    incoming.email = /my/email/hook
    incoming.autobuild = /my/build/hook

  Most hooks are run with environment variables set that give useful
  additional information. For each hook below, the environment
  variables it is passed are listed with names of the form "$HG_foo".

  changegroup;;
    Run after a changegroup has been added via push, pull or
    unbundle. ID of the first new changeset is in $HG_NODE. URL from
    which changes came is in $HG_URL.

    $HG_NODE. Name of tag is in $HG_TAG. Tag is local if
    $HG_LOCAL=1, in repo if $HG_LOCAL=0.
  update;;
    Run after updating the working directory. Changeset ID of first
    new parent is in $HG_PARENT1. If merge, ID of second new parent
    is in $HG_PARENT2. If the update succeeded, $HG_ERROR=0. If the
    update failed (e.g. because conflicts not resolved), $HG_ERROR=1.

  Note: it is generally better to use standard hooks rather
  than the generic pre- and post- command hooks as they are
  guaranteed to be called in the appropriate contexts for
  influencing transactions. Also, hooks like "commit" will be
  called in all contexts that generate a commit (e.g. tag) and
  not just the commit command.

  Note2: Environment variables with empty values may not be
  passed to hooks on platforms such as Windows. As an
  example, $HG_PARENT2 will have an empty value under
  Unix-like platforms for non-merge changesets, while it
  will not be available at all under Windows.

  The syntax for Python hooks is as follows:

    hookname = python:modulename.submodule.callable
    hookname = python:/path/to/python/module.py:callable

  Arguments listed as environment variables above are passed as
  keyword arguments, with no "HG_" prefix, and names in lower
  case.

  If a Python hook returns a "true" value or raises an
  exception, this is treated as a failure.

[[http_proxy]]
http_proxy::
  Used to access web-based Mercurial repositories through a HTTP
  proxy.

      internal:merge;;
        use the internal non-interactive merge tool
      internal:fail;;
        fail to merge

    For more information on configuring merge tools see the
    merge-tools section.

  patch;;
    command to use to apply patches. Look for 'gpatch' or 'patch' in PATH if
    unset.
  quiet;;