Change in coreboot[master]: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot
Name of user not set #1002873 has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Documentation/4.12-relnotes.md: Add a note about unit testing coreboot
Signed-off-by: Jan Dabros jsd@semihalf.com Change-Id: Id6365b86640832b91a722cd12f64c03fc8a41fd7 --- M Documentation/releases/coreboot-4.12-relnotes.md 1 file changed, 8 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/25/41025/1
diff --git a/Documentation/releases/coreboot-4.12-relnotes.md b/Documentation/releases/coreboot-4.12-relnotes.md index b172c4a..e927b4b 100644 --- a/Documentation/releases/coreboot-4.12-relnotes.md +++ b/Documentation/releases/coreboot-4.12-relnotes.md @@ -80,4 +80,12 @@
See [smmstore](../drivers/smmstore.md) for the documentation on the API.
+### Unit testing infrastructure + +Unit testing of coreboot is now possible in a more structured way, with new +build subsystem and adoption of Cmocka framework. Tree has new directory +`tests/`, which comprises infrastructure and examples of unit tests. See +[Unit testing coreboot](../technotes/2020-03-unit-testing-coreboot.md) for the +design document. + ### Add significant changes here
Name of user not set #1002873 has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 1:
Could you please build Sphinx documentation and verify once again whether link from my patch is working correctly? I've observed two different behaviors depending on environment which I've used, even though versions of recommonmark and Sphinx were the same.
In general, what is current situation with rendering of markdown internal links by Sphinx? I can see that auto_doc_ref is depreciated, but some sources claim it should be working out of the box with recommonmark0.6.0. In the same time, I can see that coreboot documentation with instructions for writing documentation in some places says that one shouldn't use normal md links, but rather place them in toctree or use rst instructions. I'm a little bit puzzled.
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 1: Code-Review+1
Patch Set 1:
Could you please build Sphinx documentation and verify once again whether link from my patch is working correctly? I've observed two different behaviors depending on environment which I've used, even though versions of recommonmark and Sphinx were the same.
In general, what is current situation with rendering of markdown internal links by Sphinx? I can see that auto_doc_ref is depreciated, but some sources claim it should be working out of the box with recommonmark0.6.0. In the same time, I can see that coreboot documentation with instructions for writing documentation in some places says that one shouldn't use normal md links, but rather place them in toctree or use rst instructions. I'm a little bit puzzled.
It mirrors the other links in the document, but we really need to sort out a consistent format and recommendations around that.
Paul Menzel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 1: Code-Review+1
(1 comment)
https://review.coreboot.org/c/coreboot/+/41025/1/Documentation/releases/core... File Documentation/releases/coreboot-4.12-relnotes.md:
https://review.coreboot.org/c/coreboot/+/41025/1/Documentation/releases/core... PS1, Line 86: Cmocka framework Make that a link?
Paul Fagerburg has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 1: Code-Review+1
Hello build bot (Jenkins), Patrick Georgi, Paul Menzel, Paul Fagerburg,
I'd like you to reexamine a change. Please visit
https://review.coreboot.org/c/coreboot/+/41025
to look at the new patch set (#2).
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Documentation/4.12-relnotes.md: Add a note about unit testing coreboot
Signed-off-by: Jan Dabros jsd@semihalf.com Change-Id: Id6365b86640832b91a722cd12f64c03fc8a41fd7 --- M Documentation/releases/coreboot-4.12-relnotes.md 1 file changed, 9 insertions(+), 0 deletions(-)
git pull ssh://review.coreboot.org:29418/coreboot refs/changes/25/41025/2
Jan Dabros has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 2:
(1 comment)
Patch Set 1: Code-Review+1
Patch Set 1:
Could you please build Sphinx documentation and verify once again whether link from my patch is working correctly? I've observed two different behaviors depending on environment which I've used, even though versions of recommonmark and Sphinx were the same.
In general, what is current situation with rendering of markdown internal links by Sphinx? I can see that auto_doc_ref is depreciated, but some sources claim it should be working out of the box with recommonmark0.6.0. In the same time, I can see that coreboot documentation with instructions for writing documentation in some places says that one shouldn't use normal md links, but rather place them in toctree or use rst instructions. I'm a little bit puzzled.
It mirrors the other links in the document, but we really need to sort out a consistent format and recommendations around that.
OK.
https://review.coreboot.org/c/coreboot/+/41025/1/Documentation/releases/core... File Documentation/releases/coreboot-4.12-relnotes.md:
https://review.coreboot.org/c/coreboot/+/41025/1/Documentation/releases/core... PS1, Line 86: Cmocka framework
Make that a link?
Done
Paul Menzel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 2: Code-Review+1
Paul Fagerburg has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 2: Code-Review+1
Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 2: Code-Review+2
Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Documentation/4.12-relnotes.md: Add a note about unit testing coreboot
Signed-off-by: Jan Dabros jsd@semihalf.com Change-Id: Id6365b86640832b91a722cd12f64c03fc8a41fd7 Reviewed-on: https://review.coreboot.org/c/coreboot/+/41025 Tested-by: build bot (Jenkins) no-reply@coreboot.org Reviewed-by: Paul Menzel paulepanter@users.sourceforge.net Reviewed-by: Paul Fagerburg pfagerburg@chromium.org Reviewed-by: Patrick Georgi pgeorgi@google.com --- M Documentation/releases/coreboot-4.12-relnotes.md 1 file changed, 9 insertions(+), 0 deletions(-)
Approvals: build bot (Jenkins): Verified Patrick Georgi: Looks good to me, approved Paul Menzel: Looks good to me, but someone else must approve Paul Fagerburg: Looks good to me, but someone else must approve
diff --git a/Documentation/releases/coreboot-4.12-relnotes.md b/Documentation/releases/coreboot-4.12-relnotes.md index b172c4a..2f0bae5 100644 --- a/Documentation/releases/coreboot-4.12-relnotes.md +++ b/Documentation/releases/coreboot-4.12-relnotes.md @@ -80,4 +80,13 @@
See [smmstore](../drivers/smmstore.md) for the documentation on the API.
+### Unit testing infrastructure + +Unit testing of coreboot is now possible in a more structured way, with new +build subsystem and adoption of [Cmocka](https://cmocka.org/) framework. Tree +has new directory `tests/`, which comprises infrastructure and examples of unit +tests. See +[Unit testing coreboot](../technotes/2020-03-unit-testing-coreboot.md) for the +design document. + ### Add significant changes here
9elements QA has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/41025 )
Change subject: Documentation/4.12-relnotes.md: Add a note about unit testing coreboot ......................................................................
Patch Set 3:
Automatic boot test returned (PASS/FAIL/TOTAL): 4/0/4 Emulation targets: "QEMU x86 q35/ich9" using payload TianoCore : SUCCESS : https://lava.9esec.io/r/3325 "QEMU x86 q35/ich9" using payload SeaBIOS : SUCCESS : https://lava.9esec.io/r/3324 "QEMU x86 i440fx/piix4" using payload SeaBIOS : SUCCESS : https://lava.9esec.io/r/3323 "QEMU AArch64" using payload LinuxBoot_u-root_kexec : SUCCESS : https://lava.9esec.io/r/3322
Please note: This test is under development and might not be accurate at all!
-
9elements QA (Code Review) -
Jan Dabros (Code Review)
-
Name of user not set (Code Review)
-
Patrick Georgi (Code Review)
-
Paul Fagerburg (Code Review)
-
Paul Menzel (Code Review)