zephyr/scripts/sanity_chk
Andrew Boie 6acbe63aea initial commit for next-gen sanity checks
The online help ./scripts/sanitycheck --help describes usage.
Most users will simply want to run with no arguments.

Change-Id: Icedbbfc22599a64a6e3dbbb808ff3276db06f2e0
Signed-off-by: Andrew Boie <andrew.p.boie@intel.com>
2016-02-05 20:14:42 -05:00
..
arches initial commit for next-gen sanity checks 2016-02-05 20:14:42 -05:00
.gitignore initial commit for next-gen sanity checks 2016-02-05 20:14:42 -05:00
bt_regression_chk sanity: Replace obsolete BSP_FLAG with PLATFORM_FLAG 2016-02-05 20:14:39 -05:00
bt_regression_chk.data Renames supported platform configurations 2016-02-05 20:14:39 -05:00
common.defs Renames supported platform configurations 2016-02-05 20:14:39 -05:00
footprint_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
footprint_chk.data Renames supported platform configurations 2016-02-05 20:14:39 -05:00
out-of-tree_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
out-of-tree_chk.data Renames supported platform configurations 2016-02-05 20:14:39 -05:00
README.txt sanity: Key off platform instead of BSP 2016-02-05 20:14:21 -05:00
regression_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
regression_chk.data Renames supported platform configurations 2016-02-05 20:14:39 -05:00
sanity_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
sanity_last_release.csv initial commit for next-gen sanity checks 2016-02-05 20:14:42 -05:00

Sanity Check Data Files
=======================

The sanity check data files contain project metadata that is parsed by the
relevant sanity check script to both build and run the listed projects.

Project metadata consists of:
 - project directory (relative to PRJ_PATH - defined in the script)
 - build arguments (optional)
 - project flags, enclosed in angle brackets "<>"
   - 'u' => microkernel; 'n' => nanokernel (required; must be first flag)
   - 'q' => run as part of quick sanity check (optional)
 - list of platform names that can be used with the project

It is important that each set of project metadata be specified on a single line.

The sanity check scripts will select first listed platform name if the user
does not specify a platform name (i.e. is the "default" platform).

A given project can appear more than once, allowing the project to be
sanitized multiple times. This can be useful if the project has multiple
configurations, or if the project should be characterized on more than one
platform during a default platform sanity check.

Comment lines are permitted (denoted by '#').