summaryrefslogtreecommitdiff
path: root/poky/documentation/contributor-guide
diff options
context:
space:
mode:
authorPatrick Williams <patrick@stwcx.xyz>2024-07-12 18:58:04 +0300
committerPatrick Williams <patrick@stwcx.xyz>2024-07-12 19:41:04 +0300
commitc5cbd62a943a317c1b4575c5f3a92df40c042c97 (patch)
tree47db1af3c6ff2943edab349fbff251d2029052f0 /poky/documentation/contributor-guide
parent7363086d8a6f87f6c162a314937f1c2e3c063b42 (diff)
downloadopenbmc-nanbield.tar.xz
subtree updatesnanbield
meta-arm: 9a4ae38e84..150169d01f: Jon Mason (1): arm/linux-yocto: backport patch to fix 6.5.13 networking issues meta-raspberrypi: fde68b24f0..fd79e74cbc: Khem Raj (2): linux-raspberrypi_6.1.bb: Upgrade to 6.1.74 linux-raspberrypi: Upgrade to 6.1.77 Martin Jansa (1): u-boot: backport one commit from v2024.01 to fix booting from uSD poky: 1a5c00f00c..7b8aa378d0: Alex Kiernan (1): wireless-regdb: Upgrade 2023.09.01 -> 2024.01.23 Alexander Kanavin (3): linux-firmware: upgrade 20231211 -> 20240220 sdk-manual: correctly describe separate build-sysroots tasks in direct sdk workflows dev-manual: improve descriptions of 'bitbake -S printdiff' BELOUARGA Mohamed (1): ref-manual: add documentation of the variable SPDX_NAMESPACE_PREFIX Bruce Ashfield (2): linux-yocto/6.1: update to v6.1.78 linux-yocto/6.1: update CVE exclusions Claus Stovgaard (1): wpa-supplicant: Fix CVE-2023-52160 Dhairya Nagodra (2): glibc: Remove duplicate entry for CVE-2023-4527 xwayland: upgrade 23.2.3 -> 23.2.4 Geoff Parker (1): ref-manual: variables: adding multiple groups in GROUPADD_PARAM Johan Bezem (1): ref-manual: variables: correct sdk installation default path Khem Raj (1): core-image-ptest: Increase disk size to 1.5G for strace ptest image Lee Chee Yang (3): libxml2: upgrade to 2.11.7 openssl: upgrade to 3.1.5 migration-guides: add release notes for 4.0.17 Luca Ceresoli (2): ref-manual: tasks: do_cleanall: recommend using '-f' instead ref-manual: tasks: do_cleansstate: recommend using '-f' instead for a shared sstate Martin Jansa (1): contributor-guide: be more specific about meta-* trees Michael Halstead (1): yocto-uninative: Update to 4.4 for glibc 2.39 Michael Opdenacker (13): ref-manual: system-requirements: update packages to build docs ref-manual: release-process: grammar fix manuals: suppress excess use of "following" word dev-manual: packages: clarify shared PR service constraint dev-manual: packages: need enough free space dev-manual: packages: fix capitalization manuals: document VIRTUAL-RUNTIME variables manuals: add initial stylechecks with Vale profile-manual: usage.rst: formatting fixes manuals: use "manual page(s)" profile-manual: usage.rst: fix reference to bug report documentation: Makefile: remove releases.rst in "make clean" profile-manual: usage.rst: further style improvements Munehisa Kamata (1): kernel.bbclass: Set pkg-config variables for building modules Pavel Zhukov (1): mdadm: Disable ptests Priyal Doshi (1): tzdata : Upgrade to 2024a Ross Burton (4): curl: improve run-ptest curl: increase test timeouts openssl: fix crash on aarch64 if BTI is enabled but no Crypto instructions gstreamer1.0: skip a test that is known to be flaky Simone Weiß (4): dev-manual: Rephrase spdx creation gnutls: Upgrade 3.8.2 -> 3.8.3 contributor-guide: add notes for tests cve-check: Log if CVE_STATUS set but not reported for component Soumya Sambu (1): bind: Upgrade 9.18.21 -> 9.18.24 Steve Sakoman (3): poky.conf: bump version for 4.3.4 release build-appliance-image: Update to nanbield head revision build-appliance-image: Update to nanbield head revision Tim Orling (1): vim: upgrade v9.0.2130 -> v9.0.2190 Wang Mingyu (3): python3-jinja2: upgrade 3.1.2 -> 3.1.3 bind: upgrade 9.18.20 -> 9.18.21 gnutls: upgrade 3.8.1 -> 3.8.2 Yoann Congal (6): cve-update-nvd2-native: Fix typo in comment cve-update-nvd2-native: Add an age threshold for incremental update cve-update-nvd2-native: Remove duplicated CVE_CHECK_DB_FILE definition cve-update-nvd2-native: nvd_request_next: Improve comment cve-update-nvd2-native: Fix CVE configuration update cve-update-nvd2-native: Remove rejected CVE from database Change-Id: I041c2504ee3a1b3275770a6949606db7f6e22ee0 Signed-off-by: Patrick Williams <patrick@stwcx.xyz>
Diffstat (limited to 'poky/documentation/contributor-guide')
-rw-r--r--poky/documentation/contributor-guide/submit-changes.rst39
1 files changed, 36 insertions, 3 deletions
diff --git a/poky/documentation/contributor-guide/submit-changes.rst b/poky/documentation/contributor-guide/submit-changes.rst
index 61f3157d60..dfeb0305c3 100644
--- a/poky/documentation/contributor-guide/submit-changes.rst
+++ b/poky/documentation/contributor-guide/submit-changes.rst
@@ -221,6 +221,38 @@ to add the upgraded version.
<https://www.kernel.org/doc/html/latest/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes>`__
in the Linux kernel documentation.
+Test your changes
+-----------------
+
+For each contributions you make, you should test your changes as well.
+For this the Yocto Project offers several types of tests. Those tests cover
+different areas and it depends on your changes which are feasible. For example run:
+
+ - For changes that affect the build environment:
+
+ - ``bitbake-selftest``: for changes within BitBake
+
+ - ``oe-selftest``: to test combinations of BitBake runs
+
+ - ``oe-build-perf-test``: to test the performance of common build scenarios
+
+ - For changes in a recipe:
+
+ - ``ptest``: run package specific tests, if they exist
+
+ - ``testimage``: build an image, boot it and run testcases on it
+
+ - If applicable, ensure also the ``native`` and ``nativesdk`` variants builds
+
+ - For changes relating to the SDK:
+
+ - ``testsdk``: to build, install and run tests against a SDK
+
+ - ``testsdk_ext``: to build, install and run tests against an extended SDK
+
+Note that this list just gives suggestions and is not exhaustive. More details can
+be found here: :ref:`test-manual/intro:Yocto Project Tests --- Types of Testing Overview`.
+
Creating Patches
================
@@ -285,8 +317,9 @@ Validating Patches with Patchtest
``patchtest`` is available in ``openembedded-core`` as a tool for making
sure that your patches are well-formatted and contain important info for
maintenance purposes, such as ``Signed-off-by`` and ``Upstream-Status``
-tags. Currently, it only supports testing patches for
-``openembedded-core`` branches. To setup, perform the following::
+tags. Note that no functional testing of the changes will be performed by ``patchtest``.
+Currently, it only supports testing patches for ``openembedded-core`` branches.
+To setup, perform the following::
pip install -r meta/lib/patchtest/requirements.txt
source oe-init-build-env
@@ -399,7 +432,7 @@ varies by component:
:oe_lists:`bitbake-devel </g/bitbake-devel>`
mailing list.
-- *"meta-\*" trees:* These trees contain Metadata. Use the
+- *meta-poky* and *meta-yocto-bsp* trees: These trees contain Metadata. Use the
:yocto_lists:`poky </g/poky>` mailing list.
- *Documentation*: For changes to the Yocto Project documentation, use the