Sumber kernel berisi fungsi dan struktur data yang didokumentasikan, misalnya di panic.c :
/**
* panic - halt the system
* @fmt: The text string to print
*
* Display a message, then perform cleanups.
*
* This function never returns.
*/
void panic(const char *fmt, ...)
Daripada menelusuri sumber setiap saat, akan berguna untuk melihat API tersebut sebagai halaman manual dan manfaatkan kerangka dokumentasi yang ada ini.
Bagaimana Anda menginstal/membuat halaman manual kernel section 9 (/usr/share/man/man9 ) yang mendokumentasikan fungsi dan struktur data yang disebutkan di atas?
Jawaban yang Diterima:
Konten diurai secara langsung (lihat juga ini) dari sumber file .c:
Untuk menyediakan tertanam, 'C' friendly, mudah dirawat, tetapi
dokumentasi yang konsisten dan dapat diekstrak dari fungsi dan struktur data
di kernel Linux, kernel Linux telah mengadopsi
yang konsisten gaya untuk mendokumentasikan fungsi dan parameternya, serta
struktur dan anggotanya.Format untuk dokumentasi ini disebut format kernel-doc. Ini
didokumentasikan dalam file Documentation/kernel-doc-nano-HOWTO.txt ini.Gaya ini menyematkan dokumentasi dalam file sumber, menggunakan
beberapa konvensi sederhana. Skrip perl scripts/kernel-doc, beberapa template SGML
di Documentation/DocBook, dan alat lainnya memahami
konvensi ini, dan digunakan untuk mengekstrak dokumentasi yang disematkan ini ke dalam
berbagai dokumen.
[…]Tanda komentar pembuka “/**” dicadangkan untuk komentar kernel-doc.
Hanya komentar yang ditandai yang akan dipertimbangkan oleh skrip kernel-doc,
dan komentar apa pun yang ditandai harus ada di kernel-doc formatnya.
Yang berarti hanya komentar berformat seperti itu yang dapat diekstraksi dengan cara ini dan Anda dapat memanfaatkan kernel-doc Perl skrip yang digunakan oleh make proses:
kernel-doc [ -docbook | -html | -html5 | -text | -man | -list ]
[ -no-doc-sections ]
[ -function funcname [ -function funcname ...] ]
c file(s)s > outputfile
dan karena itu Anda tidak terbatas pada mandocs sasaran:
Setelah instalasi, “make psdocs”, “make pdfdocs”, “make htmldocs”, atau
“make mandocs” akan merender dokumentasi dalam format yang diminta.
Ada juga file teks khusus driver di repositori/sumber kernel. Secara umum, proyek halaman manual Linux their (pria1 melalui man8 ) tersedia untuk diunduh. Pada catatan terakhir kernel.org juga memelihara beberapa dokumentasi keluaran.
Terkait:"sudo:apt-get:perintah tidak ditemukan." setelah menghapus beberapa paket?