วิธีทำให้เคอร์เนลส่วนที่ 9 จัดการ manage ซึ่งทำหน้าที่เอกสารโครงสร้างข้อมูลและส่วนหัว?

เคอร์เนลซอร์สประกอบด้วยฟังก์ชันและโครงสร้างข้อมูลซึ่งมีการจัดทำเป็นเอกสารตัวอย่างเช่นใน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, ...)

แทนที่จะไปตามแหล่งข้อมูลทุกครั้งมันจะมีประโยชน์ในการดู API เหล่านั้นเป็นmanpagesและใช้ประโยชน์จากเฟรมเวิร์กเอกสารที่มีอยู่นี้

คุณติดตั้ง / จัดทำเคอร์เนลส่วนที่ 9 manpages ( /usr/share/man/man9) ซึ่งทำหน้าที่ของฟังก์ชั่นและโครงสร้างข้อมูลดังกล่าวได้อย่างไร?

เนื้อหาจะถูกวิเคราะห์คำโดยตรง (โปรดดูสิ่งนี้ ) จากไฟล์. c ต้นทาง¹ :

เพื่อให้การฝังตัว 'C' เป็นมิตรง่ายต่อการบำรุงรักษา แต่สอดคล้องและแยกได้เอกสารของฟังก์ชั่นและโครงสร้างข้อมูลในเคอร์เนลลินุกซ์เคอร์เนล Linux ได้นำรูปแบบที่สอดคล้องกันสำหรับฟังก์ชั่นการทำเอกสารและพารามิเตอร์ของพวกเขาและโครงสร้างและ สมาชิก.

รูปแบบสำหรับเอกสารนี้เรียกว่ารูปแบบ kernel-doc มีการบันทึกไว้ในเอกสาร / kernel-doc-nano-HOWTO.txt

สไตล์นี้ฝังเอกสารในไฟล์ต้นฉบับโดยใช้หลักการง่ายๆ สคริปต์ / kernel-doc perl script, เทมเพลต SGML บางตัวใน Documentation / DocBook และเครื่องมืออื่น ๆ เข้าใจหลักการเหล่านี้และใช้เพื่อแยกเอกสารที่ฝังนี้ลงในเอกสารต่างๆ [ ... ]

เครื่องหมายข้อคิดเห็นการเปิด "/ **" ถูกสงวนไว้สำหรับความคิดเห็น kernel-doc เฉพาะข้อคิดเห็นที่ทำเครื่องหมายไว้จะถูกพิจารณาโดยสคริปต์ kernel-doc และความคิดเห็นใด ๆ ที่ทำเครื่องหมายไว้จะต้องอยู่ในรูปแบบเคอร์เนล doc

ซึ่งหมายความว่าสามารถแยกความคิดเห็นที่มีการจัดรูปแบบเท่านั้นเช่นนี้และคุณสามารถใช้ประโยชน์จากสคริปต์Perl ที่ใช้โดยกระบวนการนี้:kernel-doc make

kernel-doc [ -docbook | -html | -html5 | -text | -man | -list ]
  [ -no-doc-sections ]
  [ -function funcname [ -function funcname ...] ]
  c file(s)s > outputfile

ดังนั้นคุณจึงไม่ จำกัดเป้าหมายmand เอกสาร :

หลังการติดตั้ง "make psdocs", "make pdfdocs", "make htmldocs" หรือ "make mandocs" จะแสดงเอกสารในรูปแบบที่ร้องขอ

นอกจากนี้ยังมีไฟล์ข้อความเฉพาะไดรเวอร์ในที่เก็บเคอร์เนล / แหล่งที่มา โดยทั่วไปของพวกเขาลินุกซ์ที่มนุษย์หน้าโครงการ ( man1ผ่านman8 ) เป็นใช้ได้สำหรับการดาวน์โหลด ในหมายเหตุสุดท้าย kernel.org ยังเก็บรักษาเอกสารการส่งออกบางส่วน

^{1. เคอร์เนลไม่ใช่กรณีเดียวที่ใช้เทคนิคดังกล่าวเพื่อสร้าง manpages coreutils ของ GNU เป็นอีกกรณีหนึ่ง manpages ส่วนใหญ่สร้างขึ้นโดยใช้เอาท์พุทของcommand --helpเนื้อหาซึ่งอยู่ในฟังก์ชั่นการใช้งานซึ่งเป็นไฟล์ยูทิลิตี้ซอร์ส ( 1 2 )}

สมมติว่าคุณใช้ Ubuntu

apt-get install linux-manual-3.2

หรือคล้ายกัน (เลือกรุ่นที่ถูกต้อง) นอกจากนี้ยังมีแพ็คเกจเอกสารอื่น

apt-get install linux-doc

แต่นี่คือ html

ดาวน์โหลดซอร์สโค้ดเคอร์เนลและในซอร์ส dir เรียกใช้งาน

make mandocs

หลังจากทำเอกสาร Man เสร็จแล้วให้ดำเนินการ

make installmandocs

/usr/local/man/man9/นี้จะติดตั้งลงในหน้าคู่มือ ตอนนี้คุณสามารถดู man pages ได้ด้วยการพิมพ์man <api-name>หรือหากคุณกำลังแก้ไขvimให้กดKชื่อ API