ic-graph.png and evpn-arp-graph.png are not kept in sync with the engine
graph as nodes and handlers are added or removed, so they would require
refreshing each time, which happens often, and each refresh means another
binary diff that's impossible to review.

Hence, add a note next to them explaining that they are an illustrative
snapshot and may no longer match the graph produced by a current build.

Assisted-by: Claude Sonnet 5, Claude Code
Signed-off-by: Xavier Simonart <[email protected]>
---
v2: Updated based on Mark's feedback i.e. do not update png files.
---
 .../incremental-processing/incremental-processing.rst    | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git 
a/Documentation/topics/incremental-processing/incremental-processing.rst 
b/Documentation/topics/incremental-processing/incremental-processing.rst
index 8986ff3cd..789059449 100644
--- a/Documentation/topics/incremental-processing/incremental-processing.rst
+++ b/Documentation/topics/incremental-processing/incremental-processing.rst
@@ -221,6 +221,15 @@ from Graphviz:
 As an example, here is each binary's graph rendered up to one representative
 node:
 
+.. note::
+
+   The images below are a snapshot taken when this documentation was
+   written, meant to illustrate what the generated output looks like. The
+   incremental-processing engine gains and loses nodes and handlers over
+   time, so a graph generated from a current build may no longer match
+   what is shown here exactly. Run the commands above against your own
+   build to get an up-to-date graph.
+
 `ovn-northd`, up to the `datapath_sync` node:
 
 .. code-block:: bash
-- 
2.56.0

_______________________________________________
dev mailing list
[email protected]
https://mail.openvswitch.org/mailman/listinfo/ovs-dev

Reply via email to