]> code.ossystems Code Review - openembedded-core.git/commitdiff
yocto-check-layer: disregard checks if referencing another README file
authorJon Mason <jdmason@kudzu.us>
Sat, 4 Dec 2021 18:18:09 +0000 (13:18 -0500)
committerRichard Purdie <richard.purdie@linuxfoundation.org>
Sat, 4 Dec 2021 23:38:42 +0000 (23:38 +0000)
It is permissible to have a layer's README reference another README.  If
this is the case, avoid other checks.  Do this by checking for the word
README (case insensitive) in the README file.  This might be too
permissive, but follows the pattern of looking for exact words (like
"patch" or "maintainer") in READMEs.

Signed-off-by: Jon Mason <jdmason@kudzu.us>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>
scripts/lib/checklayer/cases/common.py

index 52c786f77b583161aeedc3595448d8e3e2ece98e..fdfb5d18cdc6336b1ed85a0ba9fa44c47688a668 100644 (file)
@@ -26,7 +26,12 @@ class CommonCheckLayer(OECheckLayerTestCase):
             data = f.read()
         self.assertTrue(data,
                 msg="Layer contains a README file but it is empty.")
-        self.assertIn('maintainer',data)
+
+        # If a layer's README references another README, then the checks below are not valid
+        if re.search('README', data, re.IGNORECASE):
+            return
+
+        self.assertIn('maintainer', data)
         self.assertIn('patch',data)
         # Check that there is an email address in the README
         email_regex = re.compile(r"[^@]+@[^@]+")