Mercurial > hg
annotate contrib/tcsh_completion @ 27142:060f83d219b9
extensions: refuse to load extensions if minimum hg version not met
As the author of several 3rd party extensions, I frequently see bug
reports from users attempting to run my extension with an old version
of Mercurial that I no longer support in my extension. Oftentimes, the
extension will import just fine. But as soon as we run extsetup(),
reposetup(), or get into the guts of a wrapped function, we encounter
an exception and abort. Today, Mercurial will print a message about
extensions that don't have a "testedwith" declaring explicit
compatibility with the current version.
The existing mechanism is a good start. But it isn't as robust as I
would like. Specifically, Mercurial assumes compatibility by default.
This means extension authors must perform compatibility checking in
their extsetup() or we wait and see if we encounter an abort at
runtime. And, compatibility checking can involve a lot of code and
lots of error checking. It's a lot of effort for extension authors.
Oftentimes, extension authors know which versions of Mercurial there
extension works on and more importantly where it is broken.
This patch introduces a magic "minimumhgversion" attribute in
extensions. When found, the extension loading mechanism will compare
the declared version against the current Mercurial version. If the
extension explicitly states we require a newer Mercurial version, a
warning is printed and the extension isn't loaded beyond importing
the Python module. This causes a graceful failure while alerting
the user of the compatibility issue.
I would be receptive to the idea of making the failure more fatal.
However, care would need to be taken to not criple every hg command.
e.g. the user may use `hg config` to fix the hgrc and if we aborted
trying to run that, the user would effectively be locked out of `hg`!
A potential future improvement to this functionality would be to catch
ImportError for the extension/module and parse the source code for
"minimumhgversion = 'XXX'" and do similar checking. This way we could
give more information about why the extension failed to load.
author | Gregory Szorc <gregory.szorc@gmail.com> |
---|---|
date | Tue, 24 Nov 2015 15:16:25 -0800 |
parents | 2616325766e3 |
children |
rev | line source |
---|---|
1156 | 1 # |
2 # tcsh completion for Mercurial | |
3 # | |
4 # This file has been auto-generated by tcsh_completion_build.sh for | |
13515
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
5 # Mercurial Distributed SCM (version 1.7.5+157-8a220ae0b2ba) |
1156 | 6 # |
7 # Copyright (C) 2005 TK Soh. | |
8 # | |
9 # This is free software; you can redistribute it and/or modify it under | |
10 # the terms of the GNU General Public License as published by the Free | |
11 # Software Foundation; either version 2 of the License, or (at your | |
1308
2073e5a71008
Cleanup of tabs and trailing spaces.
Thomas Arendsen Hein <thomas@intevation.de>
parents:
1264
diff
changeset
|
12 # option) any later version. |
1156 | 13 # |
14 | |
15 complete hg \ | |
16 'n/--cwd/d/' 'n/-R/d/' 'n/--repository/d/' \ | |
1158
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
17 'C/-/( -R --repository \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
18 --cwd \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
19 -y --noninteractive \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
20 -q --quiet \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
21 -v --verbose \ |
7766
2b2548342265
Update tcsh completion scripts with new commands and for new help output.
Gilles Moris <gilles.moris@free.fr>
parents:
1308
diff
changeset
|
22 --config \ |
1158
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
23 --debug \ |
1264
be4a14bfaa9c
Generated new tcsh_completion with tcsh_completion_build.sh
Thomas Arendsen Hein <thomas@intevation.de>
parents:
1158
diff
changeset
|
24 --debugger \ |
7766
2b2548342265
Update tcsh completion scripts with new commands and for new help output.
Gilles Moris <gilles.moris@free.fr>
parents:
1308
diff
changeset
|
25 --encoding \ |
2b2548342265
Update tcsh completion scripts with new commands and for new help output.
Gilles Moris <gilles.moris@free.fr>
parents:
1308
diff
changeset
|
26 --encodingmode \ |
1158
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
27 --traceback \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
28 --time \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
29 --profile \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
30 --version \ |
4650ec7ef690
Regenerate tcsh_completion after bugfix in generator script
TK Soh <tksoh@freescale.com>
parents:
1156
diff
changeset
|
31 -h --help)/' \ |
7766
2b2548342265
Update tcsh completion scripts with new commands and for new help output.
Gilles Moris <gilles.moris@free.fr>
parents:
1308
diff
changeset
|
32 'p/1/(add addremove annotate blame archive \ |
13515
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
33 backout bisect bookmarks branch branches \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
34 bundle cat clone commit ci \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
35 copy cp debugancestor debugbuilddag debugcheckstate \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
36 debugcommands debugcomplete debugdag debugdata debugdate \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
37 debugfsinfo debugignore debugindex debugindexdot debuginstall \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
38 debugpushkey debugrebuildstate debugrename debugrevspec debugsetparents \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
39 debugstate debugsub debugwalk diff export \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
40 forget grep heads help identify \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
41 id import patch incoming in \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
42 init locate log history manifest \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
43 merge outgoing out parents paths \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
44 pull push recover remove rm \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
45 rename move mv resolve revert \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
46 rollback root serve showconfig debugconfig \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
47 status st summary sum tag \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
48 tags tip unbundle update up \ |
2616325766e3
contrib: update tcsh_completion for Mercurial 1.8
Gilles Moris <gilles.moris@free.fr>
parents:
11445
diff
changeset
|
49 checkout co verify version)/' |
1156 | 50 |