Archive:Development/Software Engineering Framework (zh TW)

Development/Software_Engineering_Framework

此網頁的目的是總結KDE 專案在軟體工程方面所使用的工具和步驟；換言之，所有程式設計相關的工作。這包括bug修正、審查、測試、文件、需求等等。

KDE 目前使用的工具列出了其使用範圍、已知的替代品、和優缺點。

開發工具

Template:SEFBox (zh TW)

Subversion 1.4 是 KDE 目前使用的原始碼控制管理系統，伺服器位於法蘭克福。另一個唯讀鏡像位於anonsvn.kde.org。

已有考慮移植到一個分散式原始碼控制管理工具，如 GIT。關於這件事的討論詳見 kde-scm-interest郵件列表。很可能是 git 和其他工具一起使用，諸如repo。

Template:SEFBox (zh TW)

CMake 是 KDE 目前使用的構建工具。他是由 kitware inc 開發的自由軟體，可用於 KDE 的多平台支援。

該工具被用於 KDE4 系列的建構系統，目前還沒有替換的計劃。CMake 2.6.2 版就是建構 KDE 4.2 必需的。

Template:SEFBox (zh TW)

LXR indexes classes and methods used in KDE. This can be useful for finding examples of how to use a class, and finding all uses of a class while refactoring or updating API.

審查

Template:SEFBox (zh TW)

通常 KDE 並不對單個補丁(patch)提供正規審查策略。有些補丁在提交到 SVN 之前就在相關的郵件列表審查過了。這個項目是特別針對一個大補丁或是新開發者的補丁。

As an official policy kdereview is used to review new applications and new classes for kdelibs prior to inclusion in KDE trunk. A drawback of this system is that not all reviewers report that they have reviewed the new content. It may make sense to have a checklist for reviewers to use, eg,

All new classes documented [x]
Private classes and d-pointers used where appropriate [x]
Passes all krazy checks [ ]
No obvious security concerns [ ]
Designed well/maintainable [ ]
etc...

This was discussed to some extent here, but has not yet been refined into a techbase page.

Template:SEFBox (zh TW)

許多專案使用提交過濾器來發送所有提交給相關郵件列表。

Template:SEFBox (zh TW)

KDE does not have an offical design review process. Some design review takes place as part of the kdereview process. It may be possible to further formalise this or encourage design documentation.

文件

Template:SEFBox (zh TW)

techbase.kde.org 是個MediaWiki網站，用於收集技術任務如教學、時間表和專案資訊。wiki.kde.org is a tiki-wiki site with the same function. Both are actively used. It might make sense to merge the two sites.

Template:SEFBox (zh TW)

KDE API 文件是每日生成並放在 http://api.kde.org 。它也可以使用 IDE 來生成相同的本地文件。

可以從 KDE 原始碼創建 man pages 和qthelp 文件。

Template:SEFBox (zh TW)

User documentation is generated from module doc/ folders and hosted on http://docs.kde.org.

meinproc is a KDE tool (written by Stephen Kulow which uses libxslt to transform docbook into (bzipped) html. At runtime kio_help opens that bzipped html and displays it to the user in khelpcenter.

http://userbase.kde.org is intended to be the primary source of user documentation on the web. Content will possibly be packaged for offline use in the future.

測試和品質

Template:SEFBox (zh TW)

Bug tracking in KDE currently is managed using Bugzilla 3.0. Work was recently merged on a transition to Bugzilla 3.0 from Bugzilla 2.16. There is still cleanup work going on but most features of the previous Bugzilla installation already work.

Bugzilla can be difficult to use and daunting to newbies.

Template:SEFBox (zh TW)

Additional checks are always welcome for adding to Krazy. See http://websvn.kde.org/trunk/quality/.

Template:SEFBox (zh TW)

There is interest in more build testing for KDE especially on non-linux platforms. Improvements include some standard ctest scripts that can be used to build and submit a dashboard result for kdelibs to CDash. This would be run on a cronjob for simplicity.

Builds are planned for the following platforms: