Skip to contentSkip to conversation

mmc-utils: Add bash completion

PATCH Superseded Torstein Eide 2 participants 2 messages Aug 9 – Aug 10

Subsystems (2)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 mmc-utils: Add bash completion

Add a bash completion script in completion/mmc that completes subcommands and /dev/mmcblkN device paths for all mmc commands.

Subcommand completion is driven by parsing 'mmc help' output rather than maintaining a parallel hardcoded verb list, so it stays in sync as commands are added or removed.

The completion directory is named 'completion/' rather than 'bash-completion/' so shell-specific scripts for other shells (zsh, fish, etc.) can be placed alongside it without renaming.

Add bashcompletiondir variable to the Makefile (defaulting to the standard /usr/share/bash-completion/completions) and install the script as part of 'make install'. The install path can be overridden at build time with make bashcompletiondir=<path>.

---
 Makefile       |  5 ++++-
 completion/mmc | 53 ++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/HOWTO.rst |  6 ++++++
 3 files changed, 63 insertions(+), 1 deletion(-)
 create mode 100644 completion/mmc
Makefile +4 -1
index bf8c006..607d372 100644
@@ -7,6 +7,8 @@ AM_CFLAGS = -D_FILE_OFFSET_BITS=64 -D_FORTIFY_SOURCE=2 \
 	    -DSD_IDS_PATH=\"$(idsdir)/sdcard.ids\" \
 	    -DMMC_IDS_PATH=\"$(idsdir)/multimediacard.ids\"
 CFLAGS ?= -g -O2
+idsdir = /usr/share/misc
+bashcompletiondir = /usr/share/bash-completion/completions
 objects = \
 	mmc.o \
 	mmc_cmds.o \
@@ -23,7 +25,6 @@ override CFLAGS := $(CHECKFLAGS) $(AM_CFLAGS) $(CFLAGS)
 INSTALL = install
 prefix ?= /usr/local
 bindir = $(prefix)/bin
-idsdir ?= /usr/share/misc
 LIBS=
 RESTORE_LIBS=
 mandir = /usr/share/man
@@ -63,6 +64,8 @@ install: $(progs)
 	$(INSTALL) -m755 -d $(DESTDIR)$(idsdir)
 	$(INSTALL) -m 644 sdcard.ids $(DESTDIR)$(idsdir)
 	$(INSTALL) -m 644 multimediacard.ids $(DESTDIR)$(idsdir)
+	$(INSTALL) -m755 -d $(DESTDIR)$(bashcompletiondir)
+	$(INSTALL) -m 644 completion/mmc $(DESTDIR)$(bashcompletiondir)/mmc
 
 -include $(foreach obj,$(objects), $(dir $(obj))/.$(notdir $(obj)).d)
 
completion/mmc new file +53 -0

53 lines not on this page · raw message

docs/HOWTO.rst +6 -0
index 0b486e4..3aba86f 100644
@@ -2,6 +2,12 @@
 
 Running mmc-utils
 -----------------
+**Bash completion**
+    Source ``completion/mmc`` to enable tab-completion for all subcommands and
+    device paths. When installed via ``make install``, the file is placed in
+    ``$(bashcompletiondir)`` (default: ``/usr/share/bash-completion/completions/mmc``)
+    and loaded automatically by bash-completion.
+
 **Name**
     mmc - a tool for configuring MMC storage devices
 **Synopsis**
Signature · 1 line
2.53.0
#1 lore raw
Quoted 30 lines

Add a bash completion script in completion/mmc that completes subcommands and /dev/mmcblkN device paths for all mmc commands.

Subcommand completion is driven by parsing 'mmc help' output rather than maintaining a parallel hardcoded verb list, so it stays in sync as commands are added or removed.

The completion directory is named 'completion/' rather than 'bash- completion/' so shell-specific scripts for other shells (zsh, fish, etc.) can be placed alongside it without renaming.

Add bashcompletiondir variable to the Makefile (defaulting to the standard /usr/share/bash-completion/completions) and install the script as part of 'make install'. The install path can be overridden at build time with make bashcompletiondir=<path>.

---
 Makefile       |  5 ++++-
 completion/mmc | 53
++++++++++++++++++++++++++++++++++++++++++++++++++
 docs/HOWTO.rst |  6 ++++++
 3 files changed, 63 insertions(+), 1 deletion(-)  create mode 100644

completion/mmc

Makefile +0 -0
index bf8c006..607d372 100644

Makefile AM_CFLAGS = -D_FILE_OFFSET_BITS=64 - · line 9

Quoted 3 lines
Makefile +0 -0
@@ -7,6 +7,8 @@ AM_CFLAGS = -D_FILE_OFFSET_BITS=64 -
 D_FORTIFY_SOURCE=2 \
            -DSD_IDS_PATH=\"$(idsdir)/sdcard.ids\" \
            -DMMC_IDS_PATH=\"$(idsdir)/multimediacard.ids\"

I guess you are assuming here that the lsmmc series is applied first - which is fine IMHO.

Makefile AM_CFLAGS = -D_FILE_OFFSET_BITS=64 -D_FORTIFY_SOURCE=2 \ · line 10

Quoted 2 lines
Makefile +1 -0
 CFLAGS ?= -g -O2
+idsdir = /usr/share/misc

Ditto.
'?=' is perfectly fine. I would just leave it

Makefile AM_CFLAGS = -D_FILE_OFFSET_BITS=64 -D_FORTIFY_SOURCE=2 \ · line 11

Quoted 1 line
Makefile +1 -0
+bashcompletiondir = /usr/share/bash-completion/completions

better '?=' Here also

Quoted 21 lines
Makefile +0 -0
 objects = \
        mmc.o \
        mmc_cmds.o \
Makefile +0 -0
@@ -23,7 +25,6 @@ override CFLAGS := $(CHECKFLAGS) $(AM_CFLAGS)

$(CFLAGS) INSTALL = install prefix ?= /usr/local bindir = $(prefix)/bin -idsdir ?= /usr/share/misc LIBS= RESTORE_LIBS= mandir = /usr/share/man @@ - 63,6 +64,8 @@ install: $(progs)

        $(INSTALL) -m755 -d $(DESTDIR)$(idsdir)
        $(INSTALL) -m 644 sdcard.ids $(DESTDIR)$(idsdir)
        $(INSTALL) -m 644 multimediacard.ids $(DESTDIR)$(idsdir)
Makefile +3 -0
+       $(INSTALL) -m755 -d $(DESTDIR)$(bashcompletiondir)
+       $(INSTALL) -m 644 completion/mmc
+ $(DESTDIR)$(bashcompletiondir)/mmc
 
 -include $(foreach obj,$(objects), $(dir $(obj))/.$(notdir $(obj)).d)
completion/mmc new file mode 100644 index renamed from completion/mmc +0 -0

0000000..0a93bb1

completion/mmc line 7

Quoted 7 lines
completion/mmc new file +7 -0
@@ -0,0 +1,53 @@
+_mmc_complete() {
+       local cur prev words cword
+       _init_completion || return
+
+       local devices
+       devices=$(compgen -G "/dev/mmcblk*" 2>/dev/null | grep -E
+ '^/dev/mmcblk[0-9]+$')

I think you are excluding rpmb nodes such as /dev/mmcblk0rpmb.

Thanks,
Avri

Quoted 70 lines
completion/mmc new file +9 -0
+
+       local mmcbin
+       mmcbin=$(type -P "${words[0]}") || return
+
+       # "mmc help" prints one "Usage for command\t<verb words...> <args...>"
+       # line per command. Argument placeholders always start with '<', so
+       # stripping from the first '<' onward leaves just the verb words.
+       local verbs
+       verbs=$("$mmcbin" help 2>/dev/null | sed -n 's/^Usage for

command[[:space:]]*//p' | sed 's/<.*//')

completion/mmc new file +38 -0
+       [[ -z $verbs ]] && return
+
+       local -a typed=("${words[@]:1:cword-1}")
+       local -A next_words=()
+       local have_leaf=
+
+       local line i match
+       while IFS= read -r line; do
+               [[ -z $line ]] && continue
+               local -a w
+               read -ra w <<<"$line"
+               [[ ${#w[@]} -lt ${#typed[@]} ]] && continue
+
+               match=1
+               for ((i = 0; i < ${#typed[@]}; i++)); do
+                       if [[ ${w[i]} != "${typed[i]}" ]]; then
+                               match=0
+                               break
+                       fi
+               done
+               [[ $match -eq 0 ]] && continue
+
+               if [[ ${#w[@]} -gt ${#typed[@]} ]]; then
+                       next_words[${w[${#typed[@]}]}]=1
+               else
+                       have_leaf=1
+               fi
+       done <<<"$verbs"
+
+       if [[ ${#next_words[@]} -gt 0 ]]; then
+               COMPREPLY=($(compgen -W "${!next_words[*]}" -- "$cur"))
+       elif [[ -n $have_leaf ]]; then
+               COMPREPLY=($(compgen -W "$devices" -- "$cur"))
+       fi
+}
+
+complete -F _mmc_complete mmc
+complete -F _mmc_complete ./mmc
docs/HOWTO.rst index 0b486e4..3aba86f renamed from docs/HOWTO.rst +0 -0

100644

docs/HOWTO.rst +2 -0
@@ -2,6 +2,12 @@
 
 Running mmc-utils
 -----------------
+**Bash completion**
+    Source ``completion/mmc`` to enable tab-completion for all subcommands

and

docs/HOWTO.rst +2 -0
+    device paths. When installed via ``make install``, the file is placed in
+    ``$(bashcompletiondir)`` (default: ``/usr/share/bash-

completion/completions/mmc``)

docs/HOWTO.rst +2 -1
+    and loaded automatically by bash-completion.
+
 **Name**
     mmc - a tool for configuring MMC storage devices
 **Synopsis**
--

2.53.0