Mercurial > hg
changeset 19296:da16d21cf4ed stable
doc: make it easier to read how to enable extensions
We tell people all the time that enabling extensions is not a scary
thing to do, but we don't make it easy enough for an absolute novice
to do so. When they see a suggestion to do "hg extfoo bar", the error
message tells them "see hg help extensions", but that help page
doesn't actually tell them where configuration files are.
Furthermore, the big warning about why extensions aren't enabled by
default should be pushed down a little bit. Most of the extensions
shipped by hg are not all that scary, and some very basic and useful
cosmetic extensions like graphlog, color, pager, and progress, should
be enabled for many hg users.
| author | Jordi Gutiérrez Hermoso <jordigh@octave.org> |
|---|---|
| date | Thu, 06 Jun 2013 14:05:03 -0400 |
| parents | 73066ba46ec5 |
| children | b500a663a2c7 |
| files | mercurial/help/extensions.txt |
| diffstat | 1 files changed, 10 insertions(+), 8 deletions(-) [+] |
line wrap: on
line diff
--- a/mercurial/help/extensions.txt Thu Jun 06 13:37:41 2013 -0400 +++ b/mercurial/help/extensions.txt Thu Jun 06 14:05:03 2013 -0400 @@ -3,14 +3,6 @@ existing commands, change the default behavior of commands, or implement hooks. -Extensions are not loaded by default for a variety of reasons: -they can increase startup overhead; they may be meant for advanced -usage only; they may provide potentially dangerous abilities (such -as letting you destroy or modify history); they might not be ready -for prime time; or they may alter some usual behaviors of stock -Mercurial. It is thus up to the user to activate extensions as -needed. - To enable the "foo" extension, either shipped with Mercurial or in the Python search path, create an entry for it in your configuration file, like this:: @@ -23,6 +15,16 @@ [extensions] myfeature = ~/.hgext/myfeature.py +See :hg:`help config` for more information on configuration files. + +Extensions are not loaded by default for a variety of reasons: +they can increase startup overhead; they may be meant for advanced +usage only; they may provide potentially dangerous abilities (such +as letting you destroy or modify history); they might not be ready +for prime time; or they may alter some usual behaviors of stock +Mercurial. It is thus up to the user to activate extensions as +needed. + To explicitly disable an extension enabled in a configuration file of broader scope, prepend its path with !::