From 924e7d8f6776838b6f27a08f644e65d8a80d6c14 Mon Sep 17 00:00:00 2001 From: Thomas Monjalon Date: Wed, 6 Jan 2021 10:19:43 +0100 Subject: [PATCH] doc: fix figure numbering in graph guide Some figures had a title inside the picture but not in RST file. As a consequence, some versions of Sphinx are emitting a warning. Warning, treated as error: doc/guides/prog_guide/graph_lib.rst:64: no number is assigned for figure: figure-anatomy-of-a-node The titles are moved from SVG to RST, except for graph_mem_layout.svg where in-picture title must be kept. Fixes: 4dc6d8e63c16 ("doc: add graph library guide") Cc: stable@dpdk.org Signed-off-by: Thomas Monjalon Reviewed-by: Jerin Jacob --- doc/guides/prog_guide/graph_lib.rst | 10 +++++----- doc/guides/prog_guide/img/anatomy_of_a_node.svg | 5 ----- doc/guides/prog_guide/img/link_the_nodes.svg | 5 ----- 3 files changed, 5 insertions(+), 15 deletions(-) diff --git a/doc/guides/prog_guide/graph_lib.rst b/doc/guides/prog_guide/graph_lib.rst index 5d183f86d7..fcff9c4286 100644 --- a/doc/guides/prog_guide/graph_lib.rst +++ b/doc/guides/prog_guide/graph_lib.rst @@ -61,7 +61,7 @@ Anatomy of Node: .. figure:: img/anatomy_of_a_node.* -The :numref:`figure_anatomy_of_a_node` diagram depicts the anatomy of a node. + Anatomy of a node The node is the basic building block of the graph framework. @@ -138,8 +138,7 @@ Link the Nodes to create the graph topology .. figure:: img/link_the_nodes.* -The :numref:`figure_link_the_nodes` diagram shows a graph topology after -linking the N nodes. + Topology after linking the nodes Once nodes are available to the program, Application or node public API functions can links them together to create a complex packet processing graph. @@ -322,8 +321,9 @@ Graph object memory layout .. figure:: img/graph_mem_layout.* -The :numref:`figure_graph_mem_layout` diagram shows ``rte_graph`` object memory -layout. Understanding the memory layout helps to debug the graph library and + Memory layout + +Understanding the memory layout helps to debug the graph library and improve the performance if needed. Graph object consists of a header, circular buffer to store the pending diff --git a/doc/guides/prog_guide/img/anatomy_of_a_node.svg b/doc/guides/prog_guide/img/anatomy_of_a_node.svg index fa4b5b2d5a..d3bc742e77 100644 --- a/doc/guides/prog_guide/img/anatomy_of_a_node.svg +++ b/doc/guides/prog_guide/img/anatomy_of_a_node.svg @@ -309,11 +309,6 @@ id="path109" inkscape:connector-curvature="0" style="fill:#000000;fill-opacity:0;fill-rule:evenodd" /> - - -- 2.20.1