zephyr/scripts/sanity_chk
Anas Nashif ac47c45ca0 Rename Zephyr OS into Zephyr Kernel
We are a kernel, not an OS.

Change-Id: Ib987e3e511e1bdbed6293ab5e15e598bff00b09b
Signed-off-by: Anas Nashif <anas.nashif@intel.com>
2016-02-05 20:14:26 -05:00
..
README.txt
bt_regression_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
bt_regression_chk.data
common.defs
footprint_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
footprint_chk.data
out-of-tree_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
out-of-tree_chk.data
regression_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00
regression_chk.data
sanity_chk Rename Zephyr OS into Zephyr Kernel 2016-02-05 20:14:26 -05:00

README.txt

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 '#').