幫助文檔
在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，郵件組，論壇，中文書籍等。具體索引可以參考本書后附錄。

總結

以上是生活随笔為你收集整理的Tornado帮助文档组织(zt)的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。