From: Ricardo Ungerer Date: Tue, 20 Jan 2026 19:47:22 +0000 (+0000) Subject: yocto-check-layer: Add docstring to test_readme method X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=273ddefaf3f60ef010e96df7c5a394843f09cad5;p=thirdparty%2Fopenembedded%2Fopenembedded-core.git yocto-check-layer: Add docstring to test_readme method Signed-off-by: Ricardo Ungerer Signed-off-by: Richard Purdie --- diff --git a/scripts/lib/checklayer/cases/common.py b/scripts/lib/checklayer/cases/common.py index 9ea7592ba6..d20559e163 100644 --- a/scripts/lib/checklayer/cases/common.py +++ b/scripts/lib/checklayer/cases/common.py @@ -12,6 +12,16 @@ from checklayer.case import OECheckLayerTestCase class CommonCheckLayer(OECheckLayerTestCase): def test_readme(self): + """ + Test that the layer contains a valid README file and that is meets + the following criteria: + 1. A README file exists in the layer's root directory (case-insensitive) + 2. The README file is not empty + 3. The README contains maintainer information (checks for the word "maintainer") + 4. The README contains patching instructions (checks for the word "patch") + 5. The README contains at least one email address + If the README references another README file, steps 3, 4, and 5 are skipped. + """ if self.tc.layer['type'] == LayerType.CORE: raise unittest.SkipTest("Core layer's README is top level")