mirror of
https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git/
synced 2025-04-19 20:58:31 +09:00
eb47ee0181
Kernel build commands can sometimes be long, particularly when cross-compiling, making them tedious to type and prone to mistypes. This commit introduces bash completion support for common variables and targets in Kbuild. For installation instructions, please refer to the documentation in Documentation/kbuild/bash-completion.rst. The following examples demonstrate how this saves typing. [Example 1] a long command line for cross-compiling $ make A<TAB> -> completes 'A' to 'ARCH=' $ make ARCH=<TAB> -> displays all supported architectures $ make ARCH=arm64 CR<TAB> -> completes 'CR' to 'CROSS_COMPILE=' $ make ARCH=arm64 CROSS_COMPILE=<TAB> -> displays installed toolchains $ make ARCH=arm64 CROSS_COMPILE=aa<TAB> -> completes 'CROSS_COMPILE=aa' to 'CROSS_COMPILE=aarch64-linux-gnu-' $ make ARCH=arm64 CROSS_COMPILE=aarch64-linux-gnu- def<TAB> -> completes 'def' to 'defconfig' [Example 2] a single build target $ make f<TAB> -> completes 'f' to 'fs/' $ make fs/<TAB> -> displays objects and sub-directories in fs/ $ make fs/xf<TAB> -> completes 'fs/xf' to 'fs/xfs/' $ make fs/xfs/l<TAB> -> completes 'fs/xfs/l' to 'fs/xfs/libxfs/xfs_' $ make fs/xfs/libxfs/xfs_g<TAB> -> completes 'fs/xfs/libxfs/xfs_g' to 'fs/xfs/libxfs/xfs_group.o' This does not aim to provide a complete list of variables and targets, as there are too many. However, it covers variables and targets used in common scenarios, and I hope this is useful enough. Signed-off-by: Masahiro Yamada <masahiroy@kernel.org> Reviewed-by: Nicolas Schier <n.schier@avm.de> Tested-by: Nicolas Schier <n.schier@avm.de>
66 lines
2.4 KiB
ReStructuredText
66 lines
2.4 KiB
ReStructuredText
.. SPDX-License-Identifier: GPL-2.0-only
|
|
|
|
==========================
|
|
Bash completion for Kbuild
|
|
==========================
|
|
|
|
The kernel build system is written using Makefiles, and Bash completion
|
|
for the `make` command is available through the `bash-completion`_ project.
|
|
|
|
However, the Makefiles for the kernel build are complex. The generic completion
|
|
rules for the `make` command do not provide meaningful suggestions for the
|
|
kernel build system, except for the options of the `make` command itself.
|
|
|
|
To enhance completion for various variables and targets, the kernel source
|
|
includes its own completion script at `scripts/bash-completion/make`.
|
|
|
|
This script provides additional completions when working within the kernel tree.
|
|
Outside the kernel tree, it defaults to the generic completion rules for the
|
|
`make` command.
|
|
|
|
Prerequisites
|
|
=============
|
|
|
|
The script relies on helper functions provided by `bash-completion`_ project.
|
|
Please ensure it is installed on your system. On most distributions, you can
|
|
install the `bash-completion` package through the standard package manager.
|
|
|
|
How to use
|
|
==========
|
|
|
|
You can source the script directly::
|
|
|
|
$ source scripts/bash-completion/make
|
|
|
|
Or, you can copy it into the search path for Bash completion scripts.
|
|
For example::
|
|
|
|
$ mkdir -p ~/.local/share/bash-completion/completions
|
|
$ cp scripts/bash-completion/make ~/.local/share/bash-completion/completions/
|
|
|
|
Details
|
|
=======
|
|
|
|
The additional completion for Kbuild is enabled in the following cases:
|
|
|
|
- You are in the root directory of the kernel source.
|
|
- You are in the top-level build directory created by the O= option
|
|
(checked via the `source` symlink pointing to the kernel source).
|
|
- The -C make option specifies the kernel source or build directory.
|
|
- The -f make option specifies a file in the kernel source or build directory.
|
|
|
|
If none of the above are met, it falls back to the generic completion rules.
|
|
|
|
The completion supports:
|
|
|
|
- Commonly used targets, such as `all`, `menuconfig`, `dtbs`, etc.
|
|
- Make (or environment) variables, such as `ARCH`, `LLVM`, etc.
|
|
- Single-target builds (`foo/bar/baz.o`)
|
|
- Configuration files (`*_defconfig` and `*.config`)
|
|
|
|
Some variables offer intelligent behavior. For instance, `CROSS_COMPILE=`
|
|
followed by a TAB displays installed toolchains. The list of defconfig files
|
|
shown depends on the value of the `ARCH=` variable.
|
|
|
|
.. _bash-completion: https://github.com/scop/bash-completion/
|