help/extensions.txt
branchstable
changeset 10456 64a6a896e5fb
parent 10428 e553a425751d
parent 10455 40dfd46d098f
child 10457 4f38d03d4975
equal deleted inserted replaced
10428:e553a425751d 10456:64a6a896e5fb
     1 Mercurial has the ability to add new features through the use of
       
     2 extensions. Extensions may add new commands, add options to
       
     3 existing commands, change the default behavior of commands, or
       
     4 implement hooks.
       
     5 
       
     6 Extensions are not loaded by default for a variety of reasons:
       
     7 they can increase startup overhead; they may be meant for advanced
       
     8 usage only; they may provide potentially dangerous abilities (such
       
     9 as letting you destroy or modify history); they might not be ready
       
    10 for prime time; or they may alter some usual behaviors of stock
       
    11 Mercurial. It is thus up to the user to activate extensions as
       
    12 needed.
       
    13 
       
    14 To enable the "foo" extension, either shipped with Mercurial or in
       
    15 the Python search path, create an entry for it in your hgrc, like
       
    16 this::
       
    17 
       
    18   [extensions]
       
    19   foo =
       
    20 
       
    21 You may also specify the full path to an extension::
       
    22 
       
    23   [extensions]
       
    24   myfeature = ~/.hgext/myfeature.py
       
    25 
       
    26 To explicitly disable an extension enabled in an hgrc of broader
       
    27 scope, prepend its path with !::
       
    28 
       
    29   [extensions]
       
    30   # disabling extension bar residing in /path/to/extension/bar.py
       
    31   bar = !/path/to/extension/bar.py
       
    32   # ditto, but no path was supplied for extension baz
       
    33   baz = !