Revision as of 16:34, 16 December 2010 (view source) Mikan (Talk | contribs) (Copied template to create the page) ← Older edit		Revision as of 16:37, 16 December 2010 (view source) Mikan (Talk | contribs) Newer edit →
Line 110:		Line 110:
	* Architecture Diagrams		* Architecture Diagrams
	* Etc.		* Etc.
-
-	== MIN Scripter Interface ==
-	* Table of MIN scripter interfaces with parameters and descriptions
	= Known issues =		= Known issues =

---

Revision as of 16:37, 16 December 2010

Contents 1 Introduction 1.1 Overview 1.2 Getting the Latest Version 1.3 Support & Contacts 1.4 Documentation 1.5 Licensing 1.6 Supported Devices and SW 1.7 Test Cases 1.8 Coverage 2 Running the Tests 2.1 Hardware setup and test environment 2.2 Building packages 2.3 Running test cases 2.4 Test result analysis 2.5 Troubleshooting 2.6 Configuration file examples 3 Module Design and Architecture 3.1 Architecture 4 Known issues 5 Future improvements 6 References

Introduction

Overview

• What is it? Background?
• What API is used? What version?
• What it test? What it doesn't test?
• Test types?
• Current status? Release? Under developement?

Getting the Latest Version

• Link to gitorious
• Step-by-step guide how to obtain the sources for ...
  • Latest release version (official)
  • Latest development version

• Link to meego repo to rpm package

Support & Contacts

• Where to get help? IRC, e-mail ...
• Maintainer name + e-mail + substitute name + e-mail
• If there are any specific instructions for reporting bugs for this specific test module, list them here (logs etc)
• Where to report bugs (what component etc)
  • http://wiki.meego.com/Quality/How_To_Report_Bugs

Documentation

* Links to more documentation?

Licensing

• Please see the file called COPYING

Supported Devices and SW

• List of supported (+ not supported devices, if needed for clarity)
  • Versions
  • Info about what is known to work

Supported

• N900
• nCDK Medfield (starting from version x.z)

Not supported

• Netbook

• Info about supported MeeGo releases (?)

Test Cases

• List of / link to list of test cases (test case title + description etc)
  • If the list is long put them on a separate page

Coverage

• Coverage target
• Textual coverage description
• Link to coverage sheet
• Coverage table (e.g. test types)
• Limitations, what is not covered

Running the Tests

Hardware setup and test environment

• What SW is needed? What packages need to be installed? What versions?
• What HW is needed? What versions?
• How to get accurate measurement results?
• Step-by-step guide for checking that prerequisites are met
  • HW version
  • Installed packages
  • Etc.

Building packages

• How to build package from source code
  • using build script
  • Manually (if needed)
• How to install package from repo? rpm -i ...

Running test cases

• Step-by-step instructions how to execute tests with an example
• Root or user privileges?
• What to do if something goes wrong?
  • How to run in debug mode?
  • What to look in log files?

Test result analysis

• Where are the results?
• Log files?

Troubleshooting

• What to do if something fails?
• What to check first?

Configuration file examples

• Configuration file explained
• Example of configuration file

Module Design and Architecture

Architecture

• What APIs are used? What API versions? E.g. Qt Mobility Messaging 1.0.1, link to API doc
• Architecture Diagrams
• Etc.

Known issues

• Link to open bugs on meego bugzilla
• Other known issues listed

Future improvements

• List of planned future improvements
• Later, link to backlog items to be done

References

• Links to API documentation
• Links to referred docs
• Etc.