yocto-check-layer: Add docstring to test_readme method

Signed-off-by: Ricardo Ungerer <ungerer.ricardo@gmail.com>
Signed-off-by: Richard Purdie <richard.purdie@linuxfoundation.org>

diff --git a/scripts/lib/checklayer/cases/common.py b/scripts/lib/checklayer/cases/common.py
index 9ea7592ba68a11122a9f9138b98dc90a68dcaef4..d20559e163fa34ed077dd2e2bce733e685918df3 100644 (file)
--- 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")