Index: util/README |
diff --git a/util/README b/util/README |
new file mode 100644 |
index 0000000000000000000000000000000000000000..cb99d67ed69d0a677aed584c1d0ab4a00b6e92f3 |
--- /dev/null |
+++ b/util/README |
@@ -0,0 +1,29 @@ |
+Flashrom Testing |
+ |
+Overall idea: |
+- Break tests into small chunks |
+- Have a single program that does generic setup and shutdown functions |
+- Executes specified tests in a simple loop |
+ |
+Dependencies: |
+- uuencode |
+- diff |
+- A version of flashrom which is installed in $PATH |
Stefan Reinauer
2010/11/23 19:05:30
Really? It would be very nice not having to rely o
dhendrix
2010/11/24 02:48:14
It is intended to be the "known good" version used
|
+ |
+Important environment variables: |
+FLASHROM: Path to the Flashrom binary to test |
+FLASHROM_PARAM: Parameters to pass into flashrom |
Stefan Reinauer
2010/11/23 19:05:30
The example below indicates that this would be use
dhendrix
2010/11/24 02:48:14
Good point. Chip operations such as -r and -w are
|
+ |
+Important global variables: |
Stefan Reinauer
2010/11/23 19:05:30
Why are you differentiating between global and env
dhendrix
2010/11/24 02:48:14
Good question. That bit about global variables doe
|
+BACKUP: The backup copy of ROM image which is read before executing any tests, |
Stefan Reinauer
2010/11/23 19:05:30
Does this have a default, if BACKUP is not set by
dhendrix
2010/11/24 02:48:14
Heh, this is probably why it should be documented
|
+ and restored unconditionally after execution of tests. |
+ |
+Syntax: |
+ENV_VARS="blah" ./do_tests.sh <test1> <test2> |
+ |
+Example: |
+FLASHROM="../flashrom" FLASHROM_PARAM="-p internal:bus=spi" ./do_tests foo.sh bar.sh |
+ |
+Each unit test might have its own special requirements, such as extra |
+environment variables, layout files, etc. Please read the comments at the top |
+of each unit test to ensure there are no special dependencies. |