Anastasia Klimchuk submitted this change.

View Change

Approvals: build bot (Jenkins): Verified Sergii Dmytruk: Looks good to me, approved
doc: Add doc for dummyflasher

Change-Id: I1e2039a3dcb958e96c4f1ff7b99a5629c3e83ed1
Signed-off-by: Anastasia Klimchuk <aklm@flashrom.org>
Reviewed-on: https://review.coreboot.org/c/flashrom/+/82482
Reviewed-by: Sergii Dmytruk <sergii.dmytruk@3mdeb.com>
Tested-by: build bot (Jenkins) <no-reply@coreboot.org>
---
A doc/supported_hw/supported_prog/dummyflasher.rst
M doc/supported_hw/supported_prog/index.rst
2 files changed, 15 insertions(+), 0 deletions(-)

diff --git a/doc/supported_hw/supported_prog/dummyflasher.rst b/doc/supported_hw/supported_prog/dummyflasher.rst
new file mode 100644
index 0000000..d11f59c
--- /dev/null
+++ b/doc/supported_hw/supported_prog/dummyflasher.rst
@@ -0,0 +1,14 @@
+============
+Dummyflasher
+============
+
+Dummyflasher programmer is software-only implementation of a flashrom programmer. In other words,
+it is an emulator which operates on in-memory arrays of bytes instead of a real chip. Dummyflasher does not interact with any hardware.
+
+This programmer is actively used in unit tests.
+
+Also, since dummyflasher implements all of the programmers APIs, it can be used as an example or as a starting point for implementing a new programmer.
+
+Related documents:
+
+* :doc:`/contrib_howtos/how_to_add_unit_test`
diff --git a/doc/supported_hw/supported_prog/index.rst b/doc/supported_hw/supported_prog/index.rst
index d8131a6..3f05c25 100644
--- a/doc/supported_hw/supported_prog/index.rst
+++ b/doc/supported_hw/supported_prog/index.rst
@@ -13,4 +13,5 @@
.. toctree::
:maxdepth: 1

+ dummyflasher
serprog/index

To view, visit change 82482. To unsubscribe, or for help writing mail filters, visit settings.

Gerrit-MessageType: merged
Gerrit-Project: flashrom
Gerrit-Branch: main
Gerrit-Change-Id: I1e2039a3dcb958e96c4f1ff7b99a5629c3e83ed1
Gerrit-Change-Number: 82482
Gerrit-PatchSet: 2
Gerrit-Owner: Anastasia Klimchuk <aklm@chromium.org>
Gerrit-Reviewer: Anastasia Klimchuk <aklm@chromium.org>
Gerrit-Reviewer: Sergii Dmytruk <sergii.dmytruk@3mdeb.com>
Gerrit-Reviewer: Thomas Heijligen <src@posteo.de>
Gerrit-Reviewer: build bot (Jenkins) <no-reply@coreboot.org>