Как заставить ядро разделить 9 страниц справочника, какой документ функционирует, структуры данных и заголовки?
Я нашел свой ответ здесь: https://stackoverflow.com/questions/7221757/run-automatically-program-on-startup-under-linux-ubuntu я смог создать файл / сценарий для выключения моей сенсорной панели в то время как я на моей сессии Ubuntu 12.10 Linux.
Предположим, вы используете Ubuntu,
apt-get install linux-manual-3.2
или аналогичную (выберите правильную версию). Есть также другой пакет документации
apt-get install linux-doc
но это html.
.Содержимое анализируется непосредственно (см. также это ) из источника .c файлов 1 :
Для того, чтобы обеспечить встроенный, "C" дружественный, легкий в обслуживании, но последовательная и извлекаемая документация по функциям и данным структуры в ядре Linux, в ядре Linux были приняты последовательный стиль документирования функций и их параметров, и структуры и их члены.
Формат этой документации называется форматом ядра-дока. Это . документируется в этом файле Documentation/kernel-doc-nano-HOWTO.txt.
Этот стиль встраивает документацию в исходные файлы с помощью файла несколько простых конвенций. Скрипты/кернел-доки perl скрипт, некоторые SGML шаблоны в документации/документации, а также другие инструменты понимают следующее и используются для извлечения этой встроенной документации в разные документы. [...]
Знак открывающего комментария "/**" зарезервирован для комментариев ядра-дока. Только отмеченные таким образом комментарии будут учитываться скриптами ядра-дока, и любой комментарий, помеченный таким образом, должен быть в формате kernel-doc.
Это означает, что только такие форматированные комментарии могут быть извлечены таким образом, и что вы можете использовать kernel-doc Perl скрипт, используемый процессом make:
kernel-doc [ -docbook | -html | -html5 | -text | -man | -list ]
[ -no-doc-sections ]
[ -function funcname [ -function funcname ...] ]
c file(s)s > outputfile
и, следовательно, что вы не ограничены mandocs target:
После установки, "make psdocs", "make pdfdocs", "make htmldocs", или "make mandocs" выдает документацию в запрашиваемом формате.
В репозитории/источнике ядра также имеются текстовые файлы , специфичные для драйверов . В целом, их man-страницы Linux (man1 через man8) доступны для загрузки . В последнем примечании kernel.org также поддерживает некоторую выходную документацию.
1. Ядро - не единственный случай, когда такая техника используется для генерации управляющих страниц. GNU coreutils - один из таких случаев; большинство его manpages - это сгенерированные с помощью вывода команды --help, содержимое которой находится в функции использования исходного файла утилиты ( 1 2).
Загрузите исходный код ядра и в исходном коде выполните
make mandocs
После создания документов man выполните
make installmandocs
Это позволит установить страницы руководства в /usr/local/man/man9/. Теперь вы можете просмотреть страницы руководства, набрав man , или если вы редактируете в vim, просто нажмите K над именем API.