← Documents Documentation/Kconfig GitHub 원문 ↗

Linux 6.18.37 · Documentation

Documentation Kconfig

누락 문서 dependency와 ABI file parsing 오류를 검사하는 COMPILE_TEST용 Kconfig option입니다.

Source pathDocumentation/Kconfig
Source versionLinux v6.18.37
TranslationDUJINLABS 전문 번역 + 해설

요약·해설과 원문, 전문 번역을 서로 분리했습니다. API 이름, symbol, source path는 원문 표기를 사용합니다.

1. 요약·해설

원문의 핵심 논리와 kernel programming 관점의 보충 설명입니다. 아래의 전문 번역과는 별도로 작성했습니다.

요약·해설

Kconfig:1-28

`COMPILE_TEST` 환경에서 documentation dependency와 ABI 문법 오류를 warning으로 발견하는 두 선택 항목을 정의합니다.

2. 영어 원문 전체

번역 기준이 된 Linux v6.18.37 원문입니다. 줄 번호는 이 버전의 파일 좌표입니다.

원문 전체 펼치기
1 if COMPILE_TEST
2
3 menu "Documentation"
4
5 config WARN_MISSING_DOCUMENTS
6 bool "Warn if there's a missing documentation file"
7 help
8 It is not uncommon that a document gets renamed.
9 This option makes the Kernel to check for missing dependencies,
10 warning when something is missing. Works only if the Kernel
11 is built from a git tree.
12
13 If unsure, select 'N'.
14
15 config WARN_ABI_ERRORS
16 bool "Warn if there are errors at ABI files"
17 help
18 The files under Documentation/ABI should follow what's
19 described at Documentation/ABI/README. Yet, as they're manually
20 written, it would be possible that some of those files would
21 have errors that would break them for being parsed by
22 scripts/get_abi.pl. Add a check to verify them.
23
24 If unsure, select 'N'.
25
26 endmenu
27
28 endif
29

3. 한국어 전문 번역

영어 원문의 문단 순서와 의미를 유지한 전체 번역입니다. 코드, 함수명, symbol과 URL은 원문 표기를 유지합니다.

Documentation 검사 Kconfig

1-28

이 Kconfig fragment는 `COMPILE_TEST`가 활성화된 경우에만 `Documentation` menu를 제공합니다. 두 option 모두 문서 품질 검사용이므로 확신이 없으면 `N`을 선택합니다.

Documentation 검사 option
Symbol검사 내용조건
`WARN_MISSING_DOCUMENTS`Rename 등으로 사라진 documentation dependency를 warning으로 보고Git tree에서 build할 때만 동작
`WARN_ABI_ERRORS``Documentation/ABI/README` 형식과 `scripts/get_abi.pl` parsing 오류 검사`COMPILE_TEST` menu 안에서 선택

문서 rename과 ABI 문법 오류를 build 과정에서 조기에 발견합니다.

`WARN_MISSING_DOCUMENTS`는 문서가 rename되어 dependency가 누락되는 흔한 문제를 찾습니다. `WARN_ABI_ERRORS`는 사람이 작성한 `Documentation/ABI` file이 규칙을 어겨 parser를 깨뜨리는지 검증합니다.

원문의 Kconfig syntax, indentation, `menu`, `config`, `bool`, `help`, `endmenu`, `endif` 구조는 아래 source block에 그대로 보존됩니다.

if COMPILE_TEST

menu "Documentation"

config WARN_MISSING_DOCUMENTS
        bool "Warn if there's a missing documentation file"
        help
          It is not uncommon that a document gets renamed.
          This option makes the Kernel to check for missing dependencies,
          warning when something is missing. Works only if the Kernel
          is built from a git tree.

          If unsure, select 'N'.

config WARN_ABI_ERRORS
        bool "Warn if there are errors at ABI files"
        help
          The files under Documentation/ABI should follow what's
          described at Documentation/ABI/README. Yet, as they're manually
          written, it would be possible that some of those files would
          have errors that would break them for being parsed by
          scripts/get_abi.pl. Add a check to verify them.

          If unsure, select 'N'.

endmenu

endif