CDash:FAQ: Difference between revisions

From KitwarePublic
Jump to navigationJump to search
No edit summary
No edit summary
Line 1: Line 1:
[[CDash | < CDash Main Page]]
[[CDash | < CDash Main Page]]


== General information and availability ==
= General information and availability =
=== What is CDash? ===
== What is CDash? ==
 
CDash is an open source, web-based software testing server.  
CDash is an open source, web-based software testing server.  


Line 11: Line 10:
CDash is a part of a larger software process that integrates Kitware's CMake, CTest, and CPack tools, as well as other external packages used to design, manage and maintain large scale software systems. Good examples of a CDash are the CMake quality dashboard and the VTK quality dashboard.
CDash is a part of a larger software process that integrates Kitware's CMake, CTest, and CPack tools, as well as other external packages used to design, manage and maintain large scale software systems. Good examples of a CDash are the CMake quality dashboard and the VTK quality dashboard.


=== How to I install CDash? ===
== How to I install CDash? ==
See [[CDash:Installation]].
See [[CDash:Installation]].


=== Can I customize CDash? ===
== Can I customize CDash? ==


'''Yes'''. CDash is written using XSL (Extensible Stylesheet Language), therefore you can customize it fairly easily.
'''Yes'''. CDash is written using XSL (Extensible Stylesheet Language), therefore you can customize it fairly easily.
Line 22: Line 21:
   <xsl:call-template name="headscripts"/>
   <xsl:call-template name="headscripts"/>


=== Can I create private and public projects on the same server? ===
== Can I create private and public projects on the same server? ==


'''Yes'''. CDash supports mixing private and public projects via user login. If you have very sensitive project you might want to setup another CDash with restricted access (via .htaccess or other mechanisms).
'''Yes'''. CDash supports mixing private and public projects via user login. If you have very sensitive project you might want to setup another CDash with restricted access (via .htaccess or other mechanisms).
Line 30: Line 29:
# The backup directory which is by default in CDash/backup is still writing the XML files. It is recommended to limit the access of the backup directory via a .htaccess on the web server or move the backup directory to another location (outside of the web server root)
# The backup directory which is by default in CDash/backup is still writing the XML files. It is recommended to limit the access of the backup directory via a .htaccess on the web server or move the backup directory to another location (outside of the web server root)


=== Why aren't I getting email notifications of build/test failures? ===
== Why aren't I getting email notifications of build/test failures? ==
See [[CDash:BuildEmailNotification]].
See [[CDash:BuildEmailNotification]].
= Development =
== I found a bug, what should I do? ==
Finding bugs is the first step to improving CDash's quality. Please report all bugs on the [http://www.cdash.org/Bug  online bug tracking system].

Revision as of 18:35, 5 May 2008

< CDash Main Page

General information and availability

What is CDash?

CDash is an open source, web-based software testing server.

CDash aggregates, analyzes and displays the results of software testing processes submitted from clients located around the world. Developers depend on CDash to convey the state of a software system, and to continually improve its quality.

CDash is a part of a larger software process that integrates Kitware's CMake, CTest, and CPack tools, as well as other external packages used to design, manage and maintain large scale software systems. Good examples of a CDash are the CMake quality dashboard and the VTK quality dashboard.

How to I install CDash?

See CDash:Installation.

Can I customize CDash?

Yes. CDash is written using XSL (Extensible Stylesheet Language), therefore you can customize it fairly easily.

  • Individual pages can be customized by putting the corresponding .xsl files in the local directory of the main CDash installation.
  • Header menus can be customized directly. Just make sure the header.xsl as the following lines:
  <xsl:include href="headscripts.xsl"/>
  <xsl:call-template name="headscripts"/>

Can I create private and public projects on the same server?

Yes. CDash supports mixing private and public projects via user login. If you have very sensitive project you might want to setup another CDash with restricted access (via .htaccess or other mechanisms).

Two things to keep in mind when creating private projects in CDash:

  1. RSS feeds for private project are not created (this might be a configuration option)
  2. The backup directory which is by default in CDash/backup is still writing the XML files. It is recommended to limit the access of the backup directory via a .htaccess on the web server or move the backup directory to another location (outside of the web server root)

Why aren't I getting email notifications of build/test failures?

See CDash:BuildEmailNotification.

Development

I found a bug, what should I do?

Finding bugs is the first step to improving CDash's quality. Please report all bugs on the online bug tracking system.