summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
Diffstat (limited to 'doc')
-rw-r--r--doc/.mtn2git_empty0
-rw-r--r--doc/ADD_YOUR_CHECK7
-rw-r--r--doc/README24
3 files changed, 31 insertions, 0 deletions
diff --git a/doc/.mtn2git_empty b/doc/.mtn2git_empty
new file mode 100644
index 0000000000..e69de29bb2
--- /dev/null
+++ b/doc/.mtn2git_empty
diff --git a/doc/ADD_YOUR_CHECK b/doc/ADD_YOUR_CHECK
new file mode 100644
index 0000000000..d2408dd21d
--- /dev/null
+++ b/doc/ADD_YOUR_CHECK
@@ -0,0 +1,7 @@
+To create your own check
+ - Copy the example directory which is inside modules
+ - Give your module a name
+ - Add the name of your directory to __all_tests__ in
+ lib/bittest/__init__.py
+
+Now have fun to write a clever test!
diff --git a/doc/README b/doc/README
new file mode 100644
index 0000000000..642628ec9b
--- /dev/null
+++ b/doc/README
@@ -0,0 +1,24 @@
+Bitbake QA will hold Quality Assurance Resources:
+ The primary user will be OpenEmbedded but it is useful
+for any other user bitbake as well.
+
+layout of the bitbake_qa module:
+conf/
+ It contains example configurations used to run tests
+with specified parameters (for overrides)
+
+doc/
+ This directory
+
+modules/module_name/
+ QA modules doing the actual tests
+
+
+I hope to offer the following tests soon:
+
+source_checker - It will check if the sources can still be fetched
+ and generates reports
+patch_checker - It will check if the patches still applies
+doc_checker - It will check if all variables have a documentation
+content_checker - It will check for common misusage in variables
+depends_checker - Check if native packages RDEPEND on non-native packages