make htmldocs 制作内核文档
无    2017-03-02 16:30:48    89    0    0
tianwaifeixian

Linux内核文档里面说的很清楚了:

The Linux kernel uses `Sphinx`_ to generate pretty documentation from
`reStructuredText`_ files under ``Documentation``. To build the documentation in
HTML or PDF formats, use ``make htmldocs`` or ``make pdfdocs``. The generated
documentation is placed in ``Documentation/output``.

.. _Sphinx: http://www.sphinx-doc.org/
.. _reStructuredText: http://docutils.sourceforge.net/rst.html

The reStructuredText files may contain directives to include structured
documentation comments, or kernel-doc comments, from source files. Usually these
are used to describe the functions and types and design of the code. The
kernel-doc comments have some special structure and formatting, but beyond that
they are also treated as reStructuredText.

然后开始make  

各种的error

依据报错内容添加了升级了相应的软件

sudo zypper in xmlto
sudo zypper in docbook-util
sudo zypper in python-Sphinx 
sudo zypper in python3-Sphinx 
sudo pip install --upgrade pip
sudo pip install -U Sphinx

3.1.4版本没有任何错误输出

tar xvf linux-3.1.4.tar.gz 
cd linux-3.1.4/
make help
make htmldocs

4.4的两个版本都试了生成不完整  

github上说这是个bug

我去~

补丁放出来了:https://sourceforge.net/p/docutils/bugs/303/

这种是svn的补丁 么有看懂 没打 

 

参考:

http://www.sphinx-doc.org/en/stable/index.html

http://www.sphinx-doc.org/en/stable/examples.html#books-produced-using-sphinx

https://www.ibm.com/developerworks/cn/opensource/os-sphinx-documentation/index.html

上一篇: 内核4.1.36移植启动成功

下一篇: Wrong Image Format for bootm command ERROR: can't get kernel image!

89 人读过
立即登录, 发表评论.
没有帐号? 立即注册
0 条评论
文档导航