요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.
1. 요약·해설
원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.
2. 영어 원문 전체
번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.
원문 전체 펼치기
.. 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/
3. 한국어 전문 번역
영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.
Kbuild completion 개요와 전제 조건
1-27Linux kernel build system은 Makefile로 작성되어 있으며 `make` command의 Bash completion은 `bash-completion` project가 제공합니다.
하지만 kernel build Makefile은 복잡하므로 일반 `make` completion 규칙은 `make` 자체 option 외에는 kernel build에 의미 있는 제안을 제공하지 못합니다. 여러 variable과 target completion을 보강하기 위해 kernel source는 `scripts/bash-completion/make`에 전용 script를 포함합니다.
이 script는 kernel tree 안에서 작업할 때 추가 completion을 제공하고, kernel tree 밖에서는 일반 `make` completion 규칙으로 돌아갑니다.
현재 작업 위치에 따라 적용되는 규칙입니다.
Script는 `bash-completion` project가 제공하는 helper function에 의존합니다. System에 설치되어 있어야 하며 대부분 distribution에서는 표준 package manager로 `bash-completion` package를 설치할 수 있습니다.
.. 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.
Completion script 사용 방법
28-40한 session에서 바로 사용하려면 kernel tree에서 다음과 같이 script를 source합니다.
$ source scripts/bash-completion/make항상 검색되게 하려면 Bash completion script search path에 복사할 수 있습니다. 예제는 사용자별 completion directory를 만들고 script를 그곳에 복사합니다.
$ mkdir -p ~/.local/share/bash-completion/completions
$ cp scripts/bash-completion/make ~/.local/share/bash-completion/completions/직접 source와 사용자별 설치의 차이입니다.
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/
활성화 조건과 지원 completion
41-65Kbuild 추가 completion은 kernel source root에 있거나, `O=` option으로 만든 top-level build directory에서 `source` symlink가 kernel source를 가리키거나, `make -C`가 kernel source/build directory를 지정하거나, `make -f`가 그 directory 안의 file을 지정할 때 활성화됩니다. 어느 조건도 맞지 않으면 일반 completion 규칙으로 돌아갑니다.
현재 directory와 `make` option에서 kernel tree를 식별합니다.
Completion은 `all`, `menuconfig`, `dtbs` 같은 자주 쓰는 target, `ARCH`, `LLVM` 같은 Make 또는 environment variable, `foo/bar/baz.o` 형태의 single-target build, `*_defconfig`와 `*.config` configuration file을 지원합니다.
Kbuild 전용으로 제안하는 항목입니다.
일부 variable에는 지능형 동작이 있습니다. `CROSS_COMPILE=` 뒤에서 TAB을 누르면 설치된 toolchain을 표시하고, defconfig 목록은 `ARCH=` variable 값에 따라 달라집니다. `bash-completion` project link는 `https://github.com/scop/bash-completion/`입니다.
선행 variable 값이 뒤의 후보 집합을 바꿉니다.
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/
요약·해설
bash-completion.rst:1-65`scripts/bash-completion/make`는 kernel source/build tree를 인식해 일반 `make` completion보다 구체적인 Kbuild 후보를 제공합니다. 직접 source하거나 사용자 completion search path에 설치할 수 있으며, 문맥이 kernel tree가 아니면 일반 규칙으로 돌아갑니다.
Kernel build context를 확인한 뒤 전용 또는 일반 규칙을 선택합니다.