最終更新:2019-03-04 (月) 14:38:45 (1879d)
Linuxカーネル/ドキュメント
現在の構成
kernel.org/doc kernel.org/doc/Documentation テキストファイル kernel.org/doc/htmldocs DocBook形式のドキュメント kernel.org/doc/html Sphinxでのドキュメント
Sphinxへの移行 (Linux 4.8)
- LinuxCon Japan 2016でLinuxカーネルのドキュメントにSphinxを使うという発表があった
- Linux 4.8に向けて、ドキュメントシステム「Sphinx」による文書化を提案
- kernel.org/doc/DocumentationディレクトリやKerneldocのドキュメントを、基本的にはそのままに、必要に応じてreStructuredText（reSTまたはRST）形式でマークアップ
https://cloud.watch.impress.co.jp/docs/event/1010597-4.html
https://tk0miya.hatenablog.com/entry/2016/12/26/233718
https://kernelnewbies.org/Linux_4.8#Documentation_moved_to_the_reStructuredText_format
Kernel documentation with Sphinx
part 1: how we got here https://lwn.net/Articles/692704/
part 2: how it works https://lwn.net/Articles/692705/
Linuxカーネル/ドキュメント/The Linux Kernel documentation
Linuxカーネル/ドキュメント/The Linux kernel user's and administrator's guide?
Linuxカーネル/ドキュメント/The Linux kernel user-space API guide?
Linuxカーネル/ドキュメント/Working with the kernel development community?
Linuxカーネル/ドキュメント/Development tools for the kernel?
Linuxカーネル/ドキュメント/How to write kernel documentation?
Linuxカーネル/ドキュメント/Kernel Hacking Guides?
Linuxカーネル/ドキュメント/Linux Tracing Technologies?
Linuxカーネル/ドキュメント/Kernel Maintainer Handbook?
Linuxカーネル/ドキュメント/The Linux driver implementer's API guide?
Linuxカーネル/ドキュメント/Core API Documentation?
Linuxカーネル/ドキュメント/Linux Media Subsystem Documentation?
Linuxカーネル/ドキュメント/Linux Networking Documentation?
Linuxカーネル/ドキュメント/The Linux Input Documentation?
Linuxカーネル/ドキュメント/Linux GPU Driver Developer's Guide?
Linuxカーネル/ドキュメント/Security Documentation?
Linuxカーネル/ドキュメント/Linux Sound Subsystem Documentation?
Linuxカーネル/ドキュメント/Linux Kernel Crypto API?
Linuxカーネル/ドキュメント/Linux Filesystems API?
Linuxカーネル/ドキュメント/Linux Memory Management Documentation?
Linuxカーネル/ドキュメント/BPF Documentation?
Linuxカーネル/ドキュメント/SuperH Interfaces Guide?
Linuxカーネル/ドキュメント/ext4 Data Structures and Algorithms?
Linuxカーネル/ドキュメント/Translations?
形式
場所 形式 kernel.org/doc/Documentation テキスト コメント内のkernel-doc DocBookなどで出力
