Tornado帮助文档组织(zt)

帮助文档
在docs目录下存放各种帮助手册，主要是Tornado和VxWorks相关的，也有特殊组件相关的，如TrueFFS，WindView。帮助文档有html格式或pdf格式，建议使用html格式，方便交叉关联。

如果使用html格式的手册，book.html为手册总入口，进入能看见各种手册列表，选择就能进入相关手册。Docs根目录下还包含其他几个入口文件，如下表：
book.html                                                 手册总入口
Tornado_Reference.html                     分项描述各主机工具，如WindSh，elfToBin等
Tornado_API_Reference.html             描述Tornado&nbspAPI，一般用户不用，按结构层次分类
l    ibIndex.html                                            描述Tornado&nbspAPI，按库名分类，类似VxWorks的库参考
BSP_Reference.html                            一般与自己硬板不符，可以看看sysLib
VxWorks_Reference_Manual.html     VxWorks 库手册，以库名排序描述，开发者经常参考
rtnIndex.html                                           VxWorks 库手册，以函数名排序描述，开发者经常参考

在开发中遇到问题需要帮助时，应选择合适的文件入口进入，可以加快资料查询速度。比如我们想查一个已知名称函数的原型参数或归属库，可以选择rtnIndex.html进入，可以直接找到该函数，具体帮助文档在相应的库描述中。

WindRiver的帮助文档很多，且归类不是太清晰，有些文档是直接从源代码中提取的。所以阅读帮助时需要讲究一定的顺序和方法。对 于初学者可以先看 “Tornado 2.0 Getting Started Guide”，该手册在有些版本中没有，可以到网上找找。通过该手册，用户可以建立对Tornado开发环境的基本印象，熟悉基本工具的操作等。 该手册用VxSim进行例程讲解，不需要具体的硬件目标板，这对初学者也很方便。

接下来用户可以看看WindRiver的培训资料，Workshop系列，包括4部分。以PowerPoint讲稿形式，内容比较简洁，快速阅读后可以建立对Tornado和VxWorks更深层次理解。

如果你觉得对VxWorks这个RTOS的概念还比较模糊，或没有嵌入式系统开发的从业经验，可以阅读VxWorks编程指南，它对VxWorks基本概念作了全面的描述。若该手册和VxWorks的最新版本有不符的地方，应该以VxWorks的库参考手册为准。

如果你不知道如何Tornado的功能，或在使用中遇到问题，可以参考Tornado用户指南，它对Tornado的直接用户使用有很大的帮助。

当你阅读完上面的各手册后，基本概念已经建立，可以进行实际系统开发。在实际开发过程中，用户最常用的手册为VxWorks库参考手册，不用仔细通读该手 册，只在平时遇问题时查询用。VxWorks库参考手册中文档直接由代码中提取，与VxWorks实际库情况最为吻合。

当然你在开发中会遇到自己专用组件的使用，如TureFFS、WindView、dosFs2.0、VxDCOM、VxFusion等，它们有专门的手册帮助你如何使用。

在开发过程中查询文档与初学时阅读文档不同，不追求全面的概貌，只需要局部的细节。这时我们要善于利用各手册的index部分，直接查询自己关心的关键词，可以快速找到需要的资料。这也是为什么我推荐使用html格式帮助的原因。

在你已能熟练使用Tornado和VxWorks后，若想再深层次求索细节，源代码文件将是你最好的文档。不但可以帮助明白工作机制细节，也学到一些编程技巧和规范。

除了WindRiver提供的正式文档，还有很多参考资源。如WindSurf，邮件组，论坛，中文书籍等。具体索引可以参考本书后附录。