comparison mercurial/help.py @ 8865:37d8a5ddd499

help: expand the extensions topic

8864:cad6370a15cb

    return result

def topicextensions():
    doc = _(r'''
    Mercurial has an extension mechanism for adding new features.

    To enable an extension "foo" bundled with Mercurial, create an
    entry for it your hgrc, like this:
    
       [extensions]
       foo =
    ''')

    exts, maxlength = enabledextensions()
    doc += extensionslisting(_('enabled extensions:'), exts, maxlength)

8865:37d8a5ddd499

    return result

def topicextensions():
    doc = _(r'''
    Mercurial has a mechanism for adding new features through the
    use of extensions. Extensions may bring new commands, or new
    hooks, or change some behaviors of Mercurial.

    Extensions are not loaded by default for a variety of reasons,
    they may be meant for an advanced usage or provide potentially
    dangerous commands (eg. mq or rebase allow to rewrite history),
    they might not be yet ready for prime-time, or they may alter
    some usual behaviors of stock Mercurial. It is thus up to the
    user to activate the extensions as needed.

    To enable an extension "foo" which is either shipped with
    Mercurial or in the Python search path, create an entry for
    it in your hgrc, like this:

      [extensions]
      foo =

    You may also specify the full path where an extension resides:

      [extensions]
      myfeature = ~/.hgext/myfeature.py

    To explicitly disable an extension which is enabled in an hgrc
    of broader scope, prepend its path with !:

      [extensions]
      # disabling extension bar residing in /ext/path
      hgext.bar = !/path/to/extension/bar.py
      # ditto, but no path was supplied for extension baz
      hgext.baz = !
    ''')

    exts, maxlength = enabledextensions()
    doc += extensionslisting(_('enabled extensions:'), exts, maxlength)