Lines Matching full:sample

3 Sample Definition and Criteria
9 A sample is a concise Zephyr application that provides an accessible overview of one or
16 Sample Criteria
21   * The primary purpose of a sample is to provide a reference to the user.
27   * If a sample can provide output that can be verified, then output should be evaluated against
28     expected value to have some level of testing for the sample itself.
31   * Although being able to run a sample successfully does verify the
34     :zephyr_file:`tests/` folder.  In a sample, the only thing you test is
35     buildability and, in some cases, if a sample is performing as expected, i.e. you
36     are testing the sample, not the subsystem it builds on top.
38 2. Twister should be able to build every sample.
40   * Every sample must have a YAML file. Reference: :ref:`twister_script`.
47         sample.kernel.cond_var:
59   * Do not mark the test as build only. A sample should be able to build *and*
63   * The default configuration for the sample must be in the :file:`prj.conf`
66     sample.
67   * The tests should verify the default configuration of the sample and any
68     optional features documented in the sample's README file. Sample should
69     never be used to test functionality of the subsystem or module the sample
71   * Any documented configuration options related to the sample and its
75   * Sample output can be validated by leveraging the ``harness_config`` regex option,
77   * Use ``platform_allow`` to limit test to the platforms the sample was actually
78     verified on. Those platforms should be listed in the sample's README file.
81     sample when changes are submitted to the Zephyr tree via a pull-request.
82   * Make the sample as generic as possible. Avoid making a sample platform specific unless it is
85 3. A sample should provide sufficient coverage of a subsystem, feature, or module.
98     Example: ``samples/subsys/foo/README.rst``. clearly explaining the purpose of the sample, its
99     hardware requirements, and the expected sample output, if applicable.
100   * Ensure that the ``README.rst`` file is accessible in the sample hierarchy starting at
107     * Sample output, if applicable.
110 As a starting point, this sample is a good example to refer to