refactor(_comp_deprecate_func): add version parameter

Making it the first one to make forgetting or faking it harder.

#893

Author: scop

bash_completion

@@ -41,18 +41,23 @@ fi
 shopt -s extglob progcomp
 
 # Declare a compatibility function name
-# @param $1 Old function name
-# @param $2 New function name
+# @param $1 Version of bash-completion where the deprecation occurred
+# @param $2 Old function name
+# @param $3 New function name
 _comp_deprecate_func()
 {
-    if [[ $1 != [a-zA-Z_]*([a-zA-Z_0-9]) ]]; then
-        printf 'bash_completion: %s: %s\n' "$FUNCNAME" "\$1: invalid function name '$1'" >&2
+    if (($# != 3)); then
+        printf 'bash_completion: %s: usage: %s OLD_NAME NEW_NAME DEPRECATION_VERSION\n' "$FUNCNAME" "$FUNCNAME"
         return 2
-    elif [[ $2 != [a-zA-Z_]*([a-zA-Z_0-9]) ]]; then
-        printf 'bash_completion: %s: %s\n' "$FUNCNAME" "\$2: invalid function name '$2'" >&2
+    fi
+    if [[ $2 != [a-zA-Z_]*([a-zA-Z_0-9]) ]]; then
+        printf 'bash_completion: %s: %s\n' "$FUNCNAME" "\$2: invalid function name '$1'" >&2
+        return 2
+    elif [[ $3 != [a-zA-Z_]*([a-zA-Z_0-9]) ]]; then
+        printf 'bash_completion: %s: %s\n' "$FUNCNAME" "\$3: invalid function name '$2'" >&2
         return 2
     fi
-    eval -- "$1() { $2 \"\$@\"; }"
+    eval -- "$2() { $3 \"\$@\"; }"
 }
 
 # A lot of the following one-liners were taken directly from the

bash_completion.d/000_bash_completion_compat.bash

@@ -1,20 +1,21 @@
 # Deprecated bash_completion functions and variables        -*- shell-script -*-
 
-_comp_deprecate_func _userland _comp_userland
-_comp_deprecate_func _sysvdirs _comp_sysvdirs
-_comp_deprecate_func _have _comp_have_command
-_comp_deprecate_func _rl_enabled _comp_readline_variable_on
-_comp_deprecate_func _command_offset _comp_command_offset
-_comp_deprecate_func _command _comp_command
-_comp_deprecate_func _root_command _comp_root_command
-_comp_deprecate_func _xfunc _comp_xfunc
-_comp_deprecate_func _upvars _comp_upvars
-_comp_deprecate_func __reassemble_comp_words_by_ref _comp__reassemble_words
-_comp_deprecate_func __get_cword_at_cursor_by_ref _comp__get_cword_at_cursor
-_comp_deprecate_func _get_comp_words_by_ref _comp_get_words
-_comp_deprecate_func _longopt _comp_longopt
-_comp_deprecate_func _split_longopt _comp__split_longopt
-_comp_deprecate_func __ltrim_colon_completions _comp_ltrim_colon_completions
+_comp_deprecate_func 2.12 _userland _comp_userland
+_comp_deprecate_func 2.12 _sysvdirs _comp_sysvdirs
+_comp_deprecate_func 2.12 _have _comp_have_command
+_comp_deprecate_func 2.12 _rl_enabled _comp_readline_variable_on
+_comp_deprecate_func 2.12 _command_offset _comp_command_offset
+_comp_deprecate_func 2.12 _command _comp_command
+_comp_deprecate_func 2.12 _root_command _comp_root_command
+_comp_deprecate_func 2.12 _xfunc _comp_xfunc
+_comp_deprecate_func 2.12 _upvars _comp_upvars
+_comp_deprecate_func 2.12 __reassemble_comp_words_by_ref _comp__reassemble_words
+_comp_deprecate_func 2.12 __get_cword_at_cursor_by_ref \
+    _comp__get_cword_at_cursor
+_comp_deprecate_func 2.12 _get_comp_words_by_ref _comp_get_words
+_comp_deprecate_func 2.12 _longopt _comp_longopt
+_comp_deprecate_func 2.12 _split_longopt _comp__split_longopt
+_comp_deprecate_func 2.12 __ltrim_colon_completions _comp_ltrim_colon_completions
 
 # Backwards compatibility for compat completions that use have().
 # @deprecated should no longer be used; generally not needed with dynamically

completions/apt-cache

@@ -25,9 +25,10 @@ _comp_xfunc_apt_cache_src_packages()
     compgen -W '$(_comp_xfunc_apt_cache_sources "$cur")' -- "$cur"
 }
 
-_comp_deprecate_func _apt_cache_packages _comp_xfunc_apt_cache_packages
-_comp_deprecate_func _apt_cache_sources _comp_xfunc_apt_cache_sources
-_comp_deprecate_func _apt_cache_src_packages _comp_xfunc_apt_cache_src_packages
+_comp_deprecate_func 2.12 _apt_cache_packages _comp_xfunc_apt_cache_packages
+_comp_deprecate_func 2.12 _apt_cache_sources _comp_xfunc_apt_cache_sources
+_comp_deprecate_func 2.12 _apt_cache_src_packages \
+    _comp_xfunc_apt_cache_src_packages
 
 _comp_cmd_apt_cache()
 {

completions/apt-get

@@ -12,7 +12,8 @@ _comp_xfunc_apt_get_installed_packages()
     fi
 }
 
-_comp_deprecate_func _comp_cmd_apt_get_installed_packages _comp_xfunc_apt_get_installed_packages
+_comp_deprecate_func 2.12 _comp_cmd_apt_get_installed_packages \
+    _comp_xfunc_apt_get_installed_packages
 
 _comp_cmd_apt_get()
 {

completions/asciidoc

@@ -6,7 +6,7 @@ _comp_xfunc_asciidoc_doctype()
     _comp_compgen -a -- -W 'article book manpage'
 }
 
-_comp_deprecate_func _asciidoc_doctype _comp_xfunc_asciidoc_doctype
+_comp_deprecate_func 2.12 _asciidoc_doctype _comp_xfunc_asciidoc_doctype
 
 _comp_cmd_asciidoc()
 {

completions/cvs

@@ -48,7 +48,7 @@ _comp_xfunc_cvs_roots()
     _comp_ltrim_colon_completions "$cur"
 }
 
-_comp_deprecate_func _cvs_roots _comp_xfunc_cvs_roots
+_comp_deprecate_func 2.12 _cvs_roots _comp_xfunc_cvs_roots
 
 _comp_cmd_cvs()
 {

completions/iconv

@@ -7,7 +7,7 @@ _comp_xfunc_iconv_charsets()
         command sed -e "s@/*\$@@" -e "s/[,()]//g")' -- "$cur"))
 }
 
-_comp_deprecate_func _iconv_charsets _comp_xfunc_iconv_charsets
+_comp_deprecate_func 2.12 _iconv_charsets _comp_xfunc_iconv_charsets
 
 _comp_cmd_iconv()
 {

completions/list_lists

@@ -6,7 +6,7 @@ _comp_xfunc_list_lists_mailman_lists()
     COMPREPLY=($(compgen -W '$(list_lists -b 2>/dev/null)' -- "$cur"))
 }
 
-_comp_deprecate_func _mailman_lists _comp_xfunc_list_lists_mailman_lists
+_comp_deprecate_func 2.12 _mailman_lists _comp_xfunc_list_lists_mailman_lists
 
 _comp_cmd_list_lists()
 {

completions/mysql

@@ -11,7 +11,7 @@ _comp_xfunc_mysql_character_sets()
     _comp_compgen -a -- -W '"${charsets[@]}"' -X ''
 }
 
-_comp_deprecate_func _mysql_character_sets _comp_xfunc_mysql_character_sets
+_comp_deprecate_func 2.12 _mysql_character_sets _comp_xfunc_mysql_character_sets
 
 _comp_cmd_mysql()
 {

completions/python

@@ -15,8 +15,9 @@ _comp_xfunc_python_warning_actions()
         ${prefix:+-P "$prefix"}
 }
 
-_comp_deprecate_func _python_modules _comp_xfunc_python_modules
-_comp_deprecate_func _python_warning_actions _comp_xfunc_python_warning_actions
+_comp_deprecate_func 2.12 _python_modules _comp_xfunc_python_modules
+_comp_deprecate_func 2.12 _python_warning_actions \
+    _comp_xfunc_python_warning_actions
 
 _comp_cmd_python()
 {