diff options
| author |   Jon Mason <jdmason@kudzu.us> | 2021-12-04 13:18:09 -0500 |
|---|---|---|
| committer |   Richard Purdie <richard.purdie@linuxfoundation.org> | 2021-12-04 23:38:42 +0000 |
| commit | 443c73d638519d6a7ea44d1c0e80d76306687ddc (patch) | |
| tree | 251377468281b5408249c7f354dc4f147d246412 /scripts/lib | |
| parent | 5d4937bce191b7e22b807c0595d4845c88ecc560 (diff) | |
| download | openembedded-core-contrib-443c73d638519d6a7ea44d1c0e80d76306687ddc.tar.gz | |
yocto-check-layer: disregard checks if referencing another README file
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>
Diffstat (limited to 'scripts/lib')
| -rw-r--r-- | scripts/lib/checklayer/cases/common.py | 7 |
1 files changed, 6 insertions, 1 deletions
diff --git a/scripts/lib/checklayer/cases/common.py b/scripts/lib/checklayer/cases/common.py index 52c786f77b..fdfb5d18cd 100644 --- a/scripts/lib/checklayer/cases/common.py +++ b/scripts/lib/checklayer/cases/common.py @@ -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"[^@]+@[^@]+") |