diff mbox series

[3/3] docs/manual: add section describing testing external applications

Message ID 20211201230827.35080-3-matthew.weber@collins.com
State Rejected
Headers show
Series [1/3] utils/test-pkg: add support for externals | expand

Commit Message

Matthew Weber Dec. 1, 2021, 11:08 p.m. UTC
Buildroot-provided utilities can easily be leveraged to improve the
testing of applications across multiple toolchains. Add section which
describes considerations to take about reducing false positives if this
approach is taken in your br2-external.

Signed-off-by: Matthew Weber <matthew.weber@collins.com>
---
 docs/manual/customize-outside-br.txt | 15 +++++++++++++++
 1 file changed, 15 insertions(+)
diff mbox series

Patch

diff --git a/docs/manual/customize-outside-br.txt b/docs/manual/customize-outside-br.txt
index 348f2b089c..e7aeeed8c1 100644
--- a/docs/manual/customize-outside-br.txt
+++ b/docs/manual/customize-outside-br.txt
@@ -228,6 +228,21 @@  Additional Linux kernel extensions (see xref:linux-kernel-ext[]) can
 be added by storing them in the `linux/` directory at the root of a
 br2-external tree.
 
+===== Leveraging test infrastructure for your packages
+
+Buildroot provides utilities for testing packages across multiple toolchain
+conditions, as described in xref:testing-package[] below. Packages that live
+exclusively in an external environment may not be candidates for upstream and
+only have specific toolchain targets due to being internal by nature.
+Leveraging these utilities with a list of toolchains you wish to guarantee
+support (instead of depending on the utility picking toolchains for you
+randomly) is an easy way to improve the test surface of your application.
+
+In this configuration, ideally, false positives should be minimized, and
++utils/test-pkg+ should be run with the +--fail-on-skip+ flag. This option
+covers the case of a configuration dependency change (for example, between
+Buildroot versions).
+
 ===== Example layout
 
 Here is an example layout using all features of br2-external (the sample