Signed-off-by: Ricardo Ungerer <[email protected]>
---
scripts/lib/checklayer/cases/common.py | 10 ++++++++++
1 file changed, 10 insertions(+)
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")
--
2.43.0
-=-=-=-=-=-=-=-=-=-=-=-
Links: You receive all messages sent to this group.
View/Reply Online (#229791):
https://lists.openembedded.org/g/openembedded-core/message/229791
Mute This Topic: https://lists.openembedded.org/mt/117369507/21656
Group Owner: [email protected]
Unsubscribe: https://lists.openembedded.org/g/openembedded-core/unsub
[[email protected]]
-=-=-=-=-=-=-=-=-=-=-=-
