Documentation/kbuild/bash-completion.rst

1 .. SPDX-License-Identifier: GPL-2.0-only
7 The kernel build system is written using Makefiles, and Bash completion
8 for the `make` command is available through the `bash-completion`_ project.
10 However, the Makefiles for the kernel build are complex. The generic completion
11 rules for the `make` command do not provide meaningful suggestions for the
12 kernel build system, except for the options of the `make` command itself.
15 includes its own completion script at `scripts/bash-completion/make`.
18 Outside the kernel tree, it defaults to the generic completion rules for the
24 The script relies on helper functions provided by `bash-completion`_ project.
26 install the `bash-completion` package through the standard package manager.
33   $ source scripts/bash-completion/make
38   $ mkdir -p ~/.local/share/bash-completion/completions
39   $ cp scripts/bash-completion/make ~/.local/share/bash-completion/completions/
46  - You are in the root directory of the kernel source.
47  - You are in the top-level build directory created by the O= option
49  - The -C make option specifies the kernel source or build directory.
50  - The -f make option specifies a file in the kernel source or build directory.
52 If none of the above are met, it falls back to the generic completion rules.
56   - Commonly used targets, such as `all`, `menuconfig`, `dtbs`, etc.
57   - Make (or environment) variables, such as `ARCH`, `LLVM`, etc.
58   - Single-target builds (`foo/bar/baz.o`)
59   - Configuration files (`*_defconfig` and `*.config`)
65 .. _bash-completion: https://github.com/scop/bash-completion/