Les sources du noyau contiennent des fonctions et structures de données qui sont documentés, par exemple dans 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, ...)
Au lieu de parcourir les sources à chaque fois, il serait utile de visualiser ces API sous forme de manpages et tirez parti de ce cadre de documentation existant.
Comment installer/créer les pages de manuel de la section 9 du noyau (/usr/share/man/man9 ) qui documentent les fonctions et structures de données susmentionnées ?
Réponse acceptée :
Le contenu est analysé directement (voir aussi ceci) à partir de la source Fichiers .c :
Afin de fournir une documentation embarquée, conviviale en "C", facile à maintenir, mais
cohérente et extractible des fonctions et des structures de données
dans le noyau Linux, le noyau Linux a adopté une
cohérence style pour documenter les fonctions et leurs paramètres, et
les structures et leurs membres.Le format de cette documentation est appelé le format kernel-doc. Il
est documenté dans ce fichier Documentation/kernel-doc-nano-HOWTO.txt.Ce style intègre la documentation dans les fichiers source, en utilisant
quelques conventions simples. Le script perl scripts/kernel-doc, certains modèles SGML
dans Documentation/DocBook et d'autres outils comprennent ces
conventions et sont utilisés pour extraire cette documentation intégrée dans
divers documents.
/> […]La marque de commentaire d'ouverture "/**" est réservée aux commentaires kernel-doc.
Seuls les commentaires ainsi marqués seront pris en compte par les scripts kernel-doc,
et tout commentaire ainsi marqué doit être dans kernel-doc formater.
Ce qui signifie que seuls ces commentaires formatés peuvent être extraits de cette façon et que vous pouvez tirer parti du kernel-doc Perl script utilisé par le make processus :
kernel-doc [ -docbook | -html | -html5 | -text | -man | -list ]
[ -no-doc-sections ]
[ -function funcname [ -function funcname ...] ]
c file(s)s > outputfile
et donc que vous n'êtes pas limité aux mandocs cible :
Après l'installation, "make psdocs", "make pdfdocs", "make htmldocs" ou
"make mandocs" rendra la documentation dans le format demandé.
Il existe également des fichiers texte spécifiques au pilote dans le référentiel/la source du noyau. Plus généralement, leur projet de pages de manuel Linux (homme1 via man8 ) est disponible en téléchargement. Sur une dernière note, kernel.org maintient également une documentation de sortie.
Connexe :« sudo :apt-get :commande introuvable ». après avoir supprimé certains paquets ?