diff options
author | Niels Thykier <niels@thykier.net> | 2017-02-19 08:25:43 +0000 |
---|---|---|
committer | Niels Thykier <niels@thykier.net> | 2017-02-19 08:25:43 +0000 |
commit | e691259fa1c32a342dc82efdbd0518f0c6f5003f (patch) | |
tree | db27cc9786ef9709c88b4b9559ec6b87033a929d /doc/PROGRAMMING | |
parent | c7fbe36db02226e0fcdf1e1cf7660a653fb21b1d (diff) | |
download | debhelper-e691259fa1c32a342dc82efdbd0518f0c6f5003f.tar.gz |
Dh_Lib: Provide deprecated_functionality helper
Signed-off-by: Niels Thykier <niels@thykier.net>
Diffstat (limited to 'doc/PROGRAMMING')
-rw-r--r-- | doc/PROGRAMMING | 8 |
1 files changed, 8 insertions, 0 deletions
diff --git a/doc/PROGRAMMING b/doc/PROGRAMMING index eb063724..f0482ae4 100644 --- a/doc/PROGRAMMING +++ b/doc/PROGRAMMING @@ -340,6 +340,14 @@ open_gz($file) Depending on runtime features, it might be a pipe from an external process (which will die with a "SIGPIPE" if you do not consume all the input) +deprecated_functionality($warn_msg[, $rm_compat[, $rm_msg]]) + Emit $warn_msg as a deprecation warning, or error out if $rm_compat + is provided and equal to (or greater than) the active compat level. + The $rm_msg parameter can be used to provide a custom error message + in the latter case (if omitted, $warn_msg will be used in both cases). + The function will provide a separate diagnotic about which compat + level that will remove/removed the functionality if $rm_compat is + given. Sequence Addons: --------------- |