How to Write Kernel Documentation | Linux 6.18.37

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

1. 요약·해설

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

요약과 해설

index.rst:1-22

Sphinx, kernel-doc, 기여 방법, maintainer profile과 번역 갱신 검사로 이어지는 커널 문서 작성 안내 색인입니다. 영어 원문 전체와 한국어 전문 번역을 함께 제공하며 명령, source path, commit, patch와 RST directive 및 원문 줄 좌표를 보존합니다.

2. 영어 원문 전체

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

원문 전체 펼치기

1 .. _doc_guide:

3 =================================

4 How to write kernel documentation

5 =================================

7 .. toctree::

8 :maxdepth: 1

10 sphinx

11 kernel-doc

12 parse-headers

13 contributing

14 maintainer-profile

15 checktransupdate

17 .. only:: subproject and html

19 Indices

20 =======

22 * :ref:`genindex`

3. 한국어 전문 번역

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

커널 문서 작성법 목차

1-16

이 색인은 `_doc_guide` 참조 anchor를 제공하고 Sphinx, kernel-doc, header parsing, 기여 방법, maintainer profile과 번역 갱신 검사 문서를 최대 한 단계 깊이의 목차로 연결합니다.

.. toctree::
   :maxdepth: 1

   sphinx
   kernel-doc
   parse-headers
   contributing
   maintainer-profile
   checktransupdate

HTML subproject 색인

17-22

subproject HTML 빌드에서는 `Indices` 절과 일반 색인 `genindex` 참조를 표시합니다.

.. only::  subproject and html

   Indices
   =======

   * :ref:`genindex`