求问：Linux内核源码有文档吗？

henrystark

最近在看net/ipv4下TCP协议源码，有很多地方没有注释，看得很头大，求教诸位：Linux网络部分源码有详细的文档吗？就是那种描述流程、思想、函数设计意图的，如果有逐行解释的文档就更好了。。。

amarant

有一个Documention的文件夹
但是各个子系统可能有自己的主页，可以在相关的主页里找到很多文档

henrystark

回复 2# amarant


    网络子系统，tcp有关部分的文档在哪里？能给出吗？

amarant

这个。。不是有专门一本书吗

amarant

深入zxxxxxx内幕

henrystark

深入理解linux网络技术内幕，大体看了一下，感觉还不如linux内核源码剖析那本书讲得详细；以前听说过linux源码有文档的，最近都没找到。。。

T-Bagwell

有的

1. 
   
2. 
   
3. Documentation targets:
   
4. Linux kernel internal documentation in different formats:
   
5.   htmldocs        - HTML
   
6.   pdfdocs         - PDF
   
7.   psdocs          - Postscript
   
8.   xmldocs         - XML DocBook
   
9.   mandocs         - man pages
   
10.   installmandocs  - install man pages generated by mandocs
    
11.   cleandocs       - clean all generated DocBook files
    
12. 
    

复制代码

以上是make 的target

比如

1. 
   
2. /**
   
3. * input_event() - report new input event
   
4. * @dev: device that generated the event
   
5. * @type: type of the event
   
6. * @code: event code
   
7. * @value: value of the event
   
8. *
   
9. * This function should be used by drivers implementing various input
   
10. * devices to report input events. See also input_inject_event().
    
11. *
    
12. * NOTE: input_event() may be safely used right after input device was
    
13. * allocated with input_allocate_device(), even before it is registered
    
14. * with input_register_device(), but the event will not reach any of the
    
15. * input handlers. Such early invocation of input_event() may be used
    
16. * to 'seed' initial state of a switch or initial position of absolute
    
17. * axis, etc.
    
18. */
    
19. void input_event(struct input_dev *dev,
    
20.                  unsigned int type, unsigned int code, int value)
    
21. 
    

复制代码

这个是Doxygen，按照上面的方法做doc，会生成对应的格式的
文档API文档自然就有了

justlinux2010

推荐《Linux内核源码剖析 TCPIP实现---上下册》，绝对好书！

henrystark

回复 7# T-Bagwell
thanks，编译内核的时候，看到menuconfig里面有document这个模块，没仔细研究，编译出错就直接在Makefile里注释掉了，这个生成的文档就是源码注释那些吗？还有更详细的吗？


   

henrystark

回复 8# justlinux2010
的确好书，尤其是关于TCP拥塞自动机的，网上只有zhangskd讲的，也没有画状态图，这本书就有