Archive:Development/Software Engineering Framework (zh TW)

Development/Software_Engineering_Framework

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

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

開發工具

Template:SEFBox (zh TW)

Subversion 1.4 is currently used for source control management in KDE on a server hosted in Frankfurt. A separate server is used for access to the read-only mirror anonsvn.kde.org.

There is interest in migrating to a distributed source control management tool, such as GIT. Discussion of this is taking place on the kde-scm-interest mailing list. It is likely git will be used along with a tool such as repo.

Template:SEFBox (zh TW)

CMake is the build tool currently used by KDE. It is Free Software developed by kitware inc and available on multiple platforms supported by KDE.

This tool was chosen as the buildsystem for the KDE4 series, and there are no plans currently to migrate away from it. CMake version 2.6.2 will be required to build KDE 4.2 final.

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)

In general KDE does not have a formal patch review policy for individual patches. Some patches do get reviewed prior to committing to svn by the relevant mailing lists. This is the case for particularly large patches or patches by new developers.

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)

The commit filter is used by several projects to forward all commits to the relevant mailing list.

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 is a MediaWiki powered site used for collaborating on technical tasks such as tutorials, schedules, and project information. 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 documentation is generated nightly and hosted on http://api.kde.org. It is also possible to generate the same documentation locally for use in an IDE for example.

It is possible to create man pages and qthelp documentation from kde sources.

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: