Mercurial > hg
comparison mercurial/helptext/internals/extensions.txt @ 45960:bc1b4eb21da9
helptext: document the mechanism for extensions to report a version
Differential Revision: https://phab.mercurial-scm.org/D9448
author | Matt Harbison <matt_harbison@yahoo.com> |
---|---|
date | Sat, 28 Nov 2020 00:25:04 -0500 |
parents | f177fcd9cb96 |
children |
comparison
equal
deleted
inserted
replaced
45959:3a3a510617e5 | 45960:bc1b4eb21da9 |
---|---|
319 | 319 |
320 minimumhgversion = b'4.6' | 320 minimumhgversion = b'4.6' |
321 | 321 |
322 Older clients will print a warning that the extension requires a new version, | 322 Older clients will print a warning that the extension requires a new version, |
323 instead of attempting to load it. | 323 instead of attempting to load it. |
324 | |
325 The extension itself can be assigned a version value through one of two module | |
326 attributes, and will be displayed in crash reports and :hg:`version -v`:: | |
327 | |
328 * ``__version__`` is a plain value | |
329 * ``getversion`` is a no argument ``Callable`` that returns a value | |
330 | |
331 In both cases, the value must be either a byte string, or a list or tuple of | |
332 numeric values which will be joined with ``.``. | |
324 | 333 |
325 Wrap up: what belongs where? | 334 Wrap up: what belongs where? |
326 ============================ | 335 ============================ |
327 | 336 |
328 You will find here a list of most common tasks, based on setups from the | 337 You will find here a list of most common tasks, based on setups from the |