Skip to content

Commit 7f8d3c0

Browse files
akinomyogascop
andcommitted
docs(api-and-naming): describe function name _comp_complete_*
Co-authored-by: Ville Skyttä <ville.skytta@iki.fi>
1 parent b697c0a commit 7f8d3c0

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

doc/api-and-naming.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,17 +41,17 @@ deprecated in.
4141
Due to its nature, bash-completion adds a number of functions and variables in
4242
the shell's environment.
4343

44-
| | `bash_completion` | `completions/*` |
45-
|:------------------------------------|:------------------------|:--------------------------------------------------------------------------------------|
46-
| public configuration variables | `BASH_COMPLETION_*` | `BASH_COMPLETION_CMD_${Command^^}_${Config^^}` |
47-
| private non-local variables | `_comp__*` | `_comp_cmd_${Command}__${Data}` |
48-
| private non-local mutable variables | `_comp__*_mut_*` | `_comp_cmd_${Command}__mut_${Data}` |
49-
| exporter function local variables | `_*` (not `_comp*`) | `_*` (not `_comp*`) |
50-
| public/exported functions | `_comp_*` | `_comp_cmd_${Command}` (functions for `complete -F`) |
51-
| | | `_comp_xfunc_${Command}_${Utility}` (functions for use with `_comp_xfunc`) |
52-
| | `_comp_compgen_${Name}` | `_comp_xfunc_${Command}_compgen_${Name}` (generators for use with `_comp_compgen -x`) |
53-
| private/internal functions | `_comp__*` | `_comp_cmd_${Command}__${Utility}` (utility functions) |
54-
| | | `_comp_cmd_${Command}__compgen_${Name}` (generators for use with `_comp_compgen -i`) |
44+
| | `bash_completion` | `completions/*` |
45+
|:------------------------------------|:--------------------|:--------------------------------------------------------------------------------------|
46+
| public configuration variables | `BASH_COMPLETION_*` | `BASH_COMPLETION_CMD_${Command^^}_${Config^^}` |
47+
| private non-local variables | `_comp__*` | `_comp_cmd_${Command}__${Data}` |
48+
| private non-local mutable variables | `_comp__*_mut_*` | `_comp_cmd_${Command}__mut_${Data}` |
49+
| exporter function local variables | `_*` (not `_comp*`) | `_*` (not `_comp*`) |
50+
| public/exported functions | `_comp_*` | `_comp_xfunc_${Command}_${Utility}` (functions for use with `_comp_xfunc`) |
51+
| - completers (for `complete -F`) | `_comp_complete_*` | `_comp_cmd_${Command}` |
52+
| - generators | `_comp_compgen_*` | `_comp_xfunc_${Command}_compgen_${Name}` (generators for use with `_comp_compgen -x`) |
53+
| private/internal functions | `_comp__*` | `_comp_cmd_${Command}__${Utility}` (utility functions) |
54+
| - generators | | `_comp_cmd_${Command}__compgen_${Name}` (generators for use with `_comp_compgen -i`) |
5555

5656
`${Command}` refers to a command name (with characters not allowed in POSIX
5757
function or variable names replaced by an underscore), `${Config}` the name of

0 commit comments

Comments
 (0)