From 624fe80d3716d7275010e342d6f8347b25489226 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 22 Dec 2025 17:19:45 +1000 Subject: [PATCH 1/4] index: add explicit hidden toc for any submodule files not to include there are submodules which have document files just for the repository, so provide a toctree of hidden files so the warning about missing file in toc is suppressed. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend --- index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/index.rst b/index.rst index 30b19e7..4ca3611 100644 --- a/index.rst +++ b/index.rst @@ -17,3 +17,14 @@ Welcome to the OpenAMP Project Documentation protocol_details/index docs/porting_guide openamp/glossary + + +.. + TOC entries used to suppress warnings we accept for files not included in a table of contents. + WARNING: document isn't included in any toctree [toc.not_included] + +.. toctree:: + :hidden: + + openamp-system-reference/README + openamp-system-reference/LICENSE From 28dec62cde96b905615e77bbdf178ee7d207f989 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 22 Dec 2025 17:25:33 +1000 Subject: [PATCH 2/4] demos: add references to openamp-system-reference build documentation for ease of reference to build information in the submodule add a content table to the echo example documentation in the openamp-system-reference. This will also remove the warning that the file is not in a toc. WARNING: document isn't included in any toctree [toc.not_included] Signed-off-by: Sipke Vriend --- demos/echo.rst | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/demos/echo.rst b/demos/echo.rst index da2e375..b018897 100644 --- a/demos/echo.rst +++ b/demos/echo.rst @@ -117,3 +117,11 @@ This Echo Test Sample is demonstrated in the following reference implementations * :ref:`Docker Images` as demo1A * :ref:`AMD-Xilinx platforms` * :ref:`Inter Process Demos` + + +.. toctree:: + :maxdepth: 2 + :caption: Echo Test Build Information + :titlesonly: + + ../openamp-system-reference/examples/legacy_apps/examples/echo/README \ No newline at end of file From 0886f445b53cf8b230887c7fbdc43c5b66b5743e Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 16 Feb 2026 16:26:06 +1000 Subject: [PATCH 3/4] demos: add legacy app build info from openamp-system-reference repo Add the examples/legacy_apps/readme from the openamp-system-reference repository to the reference board page as the build information applies to all applications rather than any one demo from legacy_apps. Signed-off-by: Sipke Vriend --- demos/reference_boards.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/demos/reference_boards.rst b/demos/reference_boards.rst index 1fc58c4..4d6c6c9 100644 --- a/demos/reference_boards.rst +++ b/demos/reference_boards.rst @@ -19,3 +19,4 @@ number of examples. Additional supporting code is located in the system_reference-NXP system_reference-TI inter_process + ../openamp-system-reference/examples/legacy_apps/README \ No newline at end of file From 1530e3eeae4d76cb88c6c081f912aa0f63038be8 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 16 Feb 2026 16:27:49 +1000 Subject: [PATCH 4/4] gitmodules: for demonstration only change openamp-system-reference to show the rewrite of readme's in the legacy_apps examples, move the gitmodule temporarily. This commit should not be merged to main! Signed-off-by: Sipke Vriend --- .gitmodules | 2 +- openamp-system-reference | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/.gitmodules b/.gitmodules index d62f42f..9f7fb54 100644 --- a/.gitmodules +++ b/.gitmodules @@ -9,7 +9,7 @@ url = https://github.com/devicetree-org/lopper.git [submodule "openamp-system-reference"] path = openamp-system-reference - url = https://github.com/OpenAMP/openamp-system-reference.git + url = https://github.com/sipke/openamp-system-reference.git [submodule "libmetal"] path = libmetal url = https://github.com/OpenAMP/libmetal.git diff --git a/openamp-system-reference b/openamp-system-reference index 4bdabbb..fea5901 160000 --- a/openamp-system-reference +++ b/openamp-system-reference @@ -1 +1 @@ -Subproject commit 4bdabbb5b6aaaa902f56d408c091dbefc11e62ca +Subproject commit fea5901ce49d228b91c96f40a99cc1608810dd07