bios-tables-test: document expected file update

Document the flow for the case where contributor
updates the expected files.

Signed-off-by: Michael S. Tsirkin <mst@redhat.com>
This commit is contained in:
Michael S. Tsirkin 2020-01-17 07:18:18 -05:00
parent 3a61c8db9d
commit 3c2ab5593b

View File

@ -16,7 +16,10 @@
* 1. add empty files for new tables, if any, under tests/data/acpi * 1. add empty files for new tables, if any, under tests/data/acpi
* 2. list any changed files in tests/bios-tables-test-allowed-diff.h * 2. list any changed files in tests/bios-tables-test-allowed-diff.h
* 3. commit the above *before* making changes that affect the tables * 3. commit the above *before* making changes that affect the tables
* Maintainer: *
* Contributor or ACPI Maintainer (steps 4-7 need to be redone to resolve conflicts
* in binary commit created in step 6):
*
* After 1-3 above tests will pass but ignore differences with the expected files. * After 1-3 above tests will pass but ignore differences with the expected files.
* You will also notice that tests/bios-tables-test-allowed-diff.h lists * You will also notice that tests/bios-tables-test-allowed-diff.h lists
* a bunch of files. This is your hint that you need to do the below: * a bunch of files. This is your hint that you need to do the below:
@ -28,13 +31,23 @@
* output. If not - disassemble them yourself in any way you like. * output. If not - disassemble them yourself in any way you like.
* Look at the differences - make sure they make sense and match what the * Look at the differences - make sure they make sense and match what the
* changes you are merging are supposed to do. * changes you are merging are supposed to do.
* Save the changes, preferably in form of ASL diff for the commit log in
* step 6.
* *
* 5. From build directory, run: * 5. From build directory, run:
* $(SRC_PATH)/tests/data/acpi/rebuild-expected-aml.sh * $(SRC_PATH)/tests/data/acpi/rebuild-expected-aml.sh
* 6. Now commit any changes. * 6. Now commit any changes to the expected binary, include diff from step 4
* 7. Before doing a pull request, make sure tests/bios-tables-test-allowed-diff.h * in commit log.
* is empty - this will ensure following changes to ACPI tables will * 7. Before sending patches to the list (Contributor)
* be noticed. * or before doing a pull request (Maintainer), make sure
* tests/bios-tables-test-allowed-diff.h is empty - this will ensure
* following changes to ACPI tables will be noticed.
*
* The resulting patchset/pull request then looks like this:
* - patch 1: list changed files in tests/bios-tables-test-allowed-diff.h.
* - patches 2 - n: real changes, may contain multiple patches.
* - patch n + 1: update golden master binaries and empty
* tests/bios-tables-test-allowed-diff.h
*/ */
#include "qemu/osdep.h" #include "qemu/osdep.h"