關(guān)于規(guī)范FAST文檔和代碼版本的通知
發(fā)布時間:2018-08-16
自從2018年6月推出OpenBox-S4z平臺后,基于OpenBox-S4z/FAST的解決方案已經(jīng)在國防科技大學(xué)、清華大學(xué)、北京大學(xué)、電子科技大學(xué)等單位的教學(xué)和科研活動中得到應(yīng)用,涉及到計算機網(wǎng)絡(luò)教學(xué)實驗、新型路由交換(段路由)設(shè)備原型、工業(yè)互聯(lián)網(wǎng)交換設(shè)備原型、網(wǎng)絡(luò)安全防護設(shè)備原型和網(wǎng)絡(luò)測試儀原型的研發(fā)。
隨著用戶數(shù)不斷增加,用戶開發(fā)水平不斷提升,應(yīng)用開發(fā)類型不斷豐富,F(xiàn)AST平臺的一些深層次問題逐漸顯現(xiàn)。一是設(shè)計文檔不完善,用戶無法從文檔中獲取必要的信息;二是設(shè)計文檔與代碼不對應(yīng),給用戶開發(fā)帶來困擾;三是軟硬件代碼設(shè)計存在Bug,運行不穩(wěn)定;四是代碼版本管理混亂,降低開發(fā)和服務(wù)的效率。
為了解決上述問題,F(xiàn)AST社區(qū)擬開展以下工作。
一、建立和維護Bug清單
集中管理不同(單位)用戶在FAST平臺開發(fā)中遇到的問題,設(shè)置并維護Bug清單。
用戶可通過郵件或在FAST社區(qū)內(nèi)提交Bug,Bug清單及修復(fù)狀態(tài)在FAST網(wǎng)站和公眾號平臺定期發(fā)布。FAST平臺提供商和服務(wù)提供商負(fù)責(zé)相關(guān)Bug的確認(rèn)及修復(fù)。
二、強化版本管理
明確區(qū)分FAST的研發(fā)版本與發(fā)布版本,避免出現(xiàn)不同的代碼分支,造成代碼版本管理混亂,降低開發(fā)和服務(wù)的效率。
FAST平臺提供商在FPGA OS和FAST支撐軟件中設(shè)置版本標(biāo)識,F(xiàn)AST服務(wù)商提供FAST硬件流水線和FAST庫的版本標(biāo)識,為用戶提供讀取各類版本標(biāo)識的方法。
只有通過內(nèi)部測試的代碼版本才能成為發(fā)布版本,用戶從唯一的網(wǎng)址下載FAST發(fā)布的軟硬件代碼。
以后FAST的所有軟硬件代碼及文檔均只能從網(wǎng)站固定位置下載更新,不再通過其他方式交互。
三、設(shè)置常見問題列表
針對FAST論壇中用戶提出的各類問題以及回復(fù),整理常見問題(FAQ)列表,供其他用戶參考。
歡迎FAST用戶對以上工作安排提出寶貴意見,上述工作的實施細(xì)則將會在近期公布。為做好以上工作,2018年8月20日后,請所有FAST用戶從FAST網(wǎng)站下載代碼和文檔,F(xiàn)AST技術(shù)支持團隊不再通過線下直接向用戶提供代碼和文檔。