comparison mercurial/help/internals/extensions.txt @ 40596:252396a6a3f2

help: merge section about uisetup() and extsetup()

They are technically the same callback, called only once per process.
The section name "ui setup" is confusing, so shouldn't be used.

40595:419d703115b0

Extensions are loaded in phases. All extensions are processed in a given phase
before the next phase begins. In the first phase, all extension modules are
loaded and registered with Mercurial. This means that you can find all enabled
extensions with ``extensions.find`` in the following phases.

ui setup
--------

Extensions can implement an optional callback named ``uisetup``. ``uisetup``
is called when the extension is first loaded and receives a ui object::

    def uisetup(ui):
        # ...

Extension setup
---------------

Extensions can implement an optional callback named ``extsetup``. It is
called after all the extension are loaded, and can be useful in case one
extension optionally depends on another extension. Signature::

    def extsetup():
        # ...

Mercurial version 8e6019b16a7d and later (that is post-1.3.1) will pass
a ``ui``` argument to ``extsetup``::

    def extsetup(ui):
        # ...

Command table setup
-------------------

After ``extsetup``, the ``cmdtable`` is copied into the global command table

40596:252396a6a3f2

Extensions are loaded in phases. All extensions are processed in a given phase
before the next phase begins. In the first phase, all extension modules are
loaded and registered with Mercurial. This means that you can find all enabled
extensions with ``extensions.find`` in the following phases.

Extension setup
---------------

There are two callbacks to be called when extensions are loaded, named
``uisetup`` and ``extsetup``. ``uisetup`` is called first for each extension,
then ``extsetup`` is called. This means ``extsetup`` can be useful in case
one extension optionally depends on another extension.

Both ``uisetup`` and ``extsetup`` receive a ui object::

    def uisetup(ui):
        # ...

    def extsetup(ui):
        # ...

In Mercurial 1.3.1 or earlier, ``extsetup`` takes no argument.

Command table setup
-------------------

After ``extsetup``, the ``cmdtable`` is copied into the global command table