Çekirdek bölümü 9, işlevleri, veri yapılarını ve başlıkları belgeleyen sayfalar nasıl yapılır?

Çekirdek kaynakları içeren fonksiyonları ve veri yapıları , örneğin, belgelenmiştir 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, ...)

Her seferinde kaynakları gözden geçirmek yerine, bu API'ları manpaj olarak görüntülemek ve mevcut dokümantasyon çerçevesinden yararlanmak yararlı olacaktır .

Yukarıda belirtilen işlevleri ve veri yapılarını belgeleyen çekirdek bölümü 9 manajlarını ( /usr/share/man/man9) nasıl kurar / yaparsınız ?

İçerik edilir doğrudan çözümlenir (ayrıca bkz bu itibaren) kaynak .c dosyaları ¹ :

Linux çekirdeğindeki fonksiyonların ve veri yapılarının gömülü, 'C' dostu, bakımı kolay, ancak tutarlı ve çıkarılabilir dokümantasyonunu sağlamak için Linux çekirdeği, fonksiyonları, parametrelerini ve yapılarını ve bunların yapılarını belgelemek için tutarlı bir stil benimsemiştir. üyeler.

Bu dokümantasyonun formatına çekirdek-doküman formatı denir. Bu Documentation / kernel-doc-nano-HOWTO.txt dosyasında belgelenmiştir.

Bu stil, birkaç basit kural kullanarak belgeleri kaynak dosyalara gömer. Komut dosyaları / çekirdek-doc perl betiği, Documentation / DocBook içindeki bazı SGML şablonları ve diğer araçlar bu kuralları anlar ve bu gömülü belgeleri çeşitli belgelere çıkarmak için kullanılır. [...]

Açılış yorum işareti "/ **" çekirdek-doc yorumları için ayrılmıştır. Yalnızca bu şekilde işaretlenen yorumlar çekirdek-doc komut dosyaları tarafından dikkate alınacaktır ve bu şekilde işaretlenen tüm yorumlar çekirdek-belge biçiminde olmalıdır.

Bu, yalnızca bu şekilde biçimlendirilmiş yorumların bu şekilde çıkarılabileceği ve işlem tarafından kullanılan Perl komut dosyasından yararlanabileceğiniz anlamına gelir :kernel-doc make

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

ve böylece mandocs hedefiyle sınırlı değilsiniz :

Kurulumdan sonra, "psdocs yap", "pdfdocs yap", "htmldocs yap" veya "mandocs yap" belgeleri istenen formatta oluşturacaktır.

Çekirdek deposunda / kaynağında sürücüye özgü metin dosyaları da vardır . Daha genel olarak kendi Linux kılavuz sayfaları projesi ( man1 yoluyla man8 ) 'dir kullanılabilir indirmek için. Son notta kernel.org bazı çıktı belgelerini de muhafaza eder .

^{1. Çekirdekler, böyle bir tekniğin manaj üretmek için kullanıldığı tek durum değildir. GNU coreutils böyle bir durumdur; Bunu man sayfalarını en edilir üretilen çıktısı kullanılarak command --helpiçinde olan içerik kullanım işlevine yardımcı kaynak dosyası ( 1 2 ).}

Ubuntu kullandığınızı varsayarsak,

apt-get install linux-manual-3.2

veya benzeri (doğru sürümü seçin). Başka bir belge paketi daha var

apt-get install linux-doc

ama bu html.

Çekirdek kaynak kodunu indirin ve source dir execute

make mandocs

Adam belgeleri yapıldıktan sonra

make installmandocs

Bu, manuel sayfaları içine yükleyecektir /usr/local/man/man9/. Artık yazarak man sayfalarını görüntüleyebilir man <api-name>veya düzenleme yapıyorsanız , API adına vimbasın K.