From 65762d040b96c52f6ac44a350f2a95ebdfa15d35 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 22 Dec 2025 17:19:45 +1000 Subject: [PATCH 01/19] 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 fb5b5ce668f9d19e11132151bf3275ab60fcfab9 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 22 Dec 2025 17:25:33 +1000 Subject: [PATCH 02/19] demos:echo: add links to 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 | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/demos/echo.rst b/demos/echo.rst index da2e375..9c1b583 100644 --- a/demos/echo.rst +++ b/demos/echo.rst @@ -117,3 +117,14 @@ This Echo Test Sample is demonstrated in the following reference implementations * :ref:`Docker Images` as demo1A * :ref:`AMD-Xilinx platforms` * :ref:`Inter Process Demos` + + +*************************** +Echo Test Build Information +*************************** + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../openamp-system-reference/examples/legacy_apps/examples/echo/README \ No newline at end of file From 5c3ee1fc87975093cdd9bfd650b6d35ec2995857 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 16 Feb 2026 16:26:06 +1000 Subject: [PATCH 03/19] demos:reference_boards: add links to reference build information 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 928b7f8b555029a2a81903a795ba953b67cfc8ea Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Sun, 22 Feb 2026 16:29:43 +1000 Subject: [PATCH 04/19] demos:matrix_multiply: add reference to build documentation in reference for ease of reference to build information in the submodule add a content table to the 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/matrix_multiply.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/demos/matrix_multiply.rst b/demos/matrix_multiply.rst index f61dc38..464eaf9 100644 --- a/demos/matrix_multiply.rst +++ b/demos/matrix_multiply.rst @@ -131,3 +131,14 @@ This Matrix Multiply Sample is demonstrated in the following reference implement * :ref:`Docker Images` as demo1B * :ref:`AMD-Xilinx platforms` * :ref:`Inter Process Demos` + + +********************************* +Matrix Multiply Build Information +********************************* + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../openamp-system-reference/examples/legacy_apps/examples/matrix_multiply/README From 6cab97aa3819484b59271b0b60e06f241dcd47f3 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Sun, 22 Feb 2026 16:31:25 +1000 Subject: [PATCH 05/19] demos:rpmsg_multi_services: add links to reference build documentation for ease of reference to build information in the submodule add a content table to the 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/rpmsg_multi_services.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/demos/rpmsg_multi_services.rst b/demos/rpmsg_multi_services.rst index 04a3f0f..68503d0 100644 --- a/demos/rpmsg_multi_services.rst +++ b/demos/rpmsg_multi_services.rst @@ -216,3 +216,14 @@ This RPMsg Multi Services Sample is demonstrated in the following reference impl * :ref:`Texas Instruments ` * Refer to `Zephyr Build Instructions `_. + + +************************************** +RPMsg Multi Services Build Information +************************************** + +.. toctree:: + :maxdepth: 2 + :titlesonly: + + ../openamp-system-reference/examples/zephyr/rpmsg_multi_services/README From 600925d86accbaecbfbd875db458bb79eb0b4a7e Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Sun, 22 Feb 2026 16:27:00 +1000 Subject: [PATCH 06/19] demos:linux_rpc: add references to build documentation in reference repo for ease of reference to build information in the submodule add a content table to the 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/linux_rpc.rst | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/demos/linux_rpc.rst b/demos/linux_rpc.rst index 349e163..a68ac0a 100644 --- a/demos/linux_rpc.rst +++ b/demos/linux_rpc.rst @@ -102,8 +102,12 @@ This Linux RPC Sample is demonstrated in the following reference implementations * :ref:`Linux Inter Process ` + +******************************** +Linux RPC Demo Build Information +******************************** + .. toctree:: - :maxdepth: 1 - :caption: Demo Compile and Execution Instructions + :maxdepth: 2 ../openamp-system-reference/examples/legacy_apps/examples/linux_rpc_demo/README From 5743f74f395d23607da884fad5fa491b8ef7d7b8 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 23 Feb 2026 13:56:05 +1000 Subject: [PATCH 07/19] demos:linux_rpc: add reference to build of remote processor rpc demo the readthedocs demo is for linux interprocess example of rpc, but there is a remote side app as well in reference repository so add reference to it at the end of the demo for those wishing to try it. --- demos/linux_rpc.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/demos/linux_rpc.rst b/demos/linux_rpc.rst index a68ac0a..de6b061 100644 --- a/demos/linux_rpc.rst +++ b/demos/linux_rpc.rst @@ -111,3 +111,16 @@ Linux RPC Demo Build Information :maxdepth: 2 ../openamp-system-reference/examples/legacy_apps/examples/linux_rpc_demo/README + + +********************************************* +Alternate Bare Metal Remote Build Information +********************************************* + +The following sections detail how to build a baremetal remote if you wish to run this example +on a remote processor rather than secondary linux process. + +.. toctree:: + :maxdepth: 2 + + ../openamp-system-reference/examples/legacy_apps/examples/rpc_demo/README From 4ee93212c4fccf2f683f9390ae483afe673f919e Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 23 Feb 2026 14:26:17 +1000 Subject: [PATCH 08/19] demos: add amd specific system reference info to reference boards page Integrated the openamp-system-reference repository readme pages with amd specific setup and build information. Signed-off-by: Sipke Vriend --- demos/system_reference-AMD-Xilinx.rst | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/demos/system_reference-AMD-Xilinx.rst b/demos/system_reference-AMD-Xilinx.rst index 9e0b4ae..136792d 100644 --- a/demos/system_reference-AMD-Xilinx.rst +++ b/demos/system_reference-AMD-Xilinx.rst @@ -15,3 +15,10 @@ The following Reference Samples and Demos are implemented using the ../openamp-system-reference/examples/linux/rpmsg-echo-test/README.md ../openamp-system-reference/examples/linux/rpmsg-mat-mul/README.md ../openamp-system-reference/examples/linux/rpmsg-proxy-app/README.md + ../openamp-system-reference/examples/libmetal/machine/host/amd_linux_userspace/README + ../openamp-system-reference/examples/libmetal/machine/remote/amd_rpu/README + ../openamp-system-reference/examples/libmetal/machine/remote/amd_rpu/system/freertos/README + ../openamp-system-reference/examples/libmetal/machine/remote/amd_rpu/system/generic/README + ../openamp-system-reference/examples/legacy_apps/machine/xlnx/README + ../openamp-system-reference/examples/legacy_apps/machine/xlnx/microblaze_generic/README + ../openamp-system-reference/examples/linux/dts/xilinx/README From b5ec6e594cefdc089d3785445955ddbc9cdd91c4 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 23 Feb 2026 14:29:19 +1000 Subject: [PATCH 09/19] index: suppress warnings for readme that do not have readthedocs example These readme pages do not have a description page in readthedocs currently, so suppress these until decided whether to add somewhere in readthedocs where they can be integrated. Signed-off-by: Sipke Vriend --- index.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/index.rst b/index.rst index 4ca3611..dd2d3e4 100644 --- a/index.rst +++ b/index.rst @@ -28,3 +28,22 @@ Welcome to the OpenAMP Project Documentation openamp-system-reference/README openamp-system-reference/LICENSE + openamp-docs/README + + +.. + TOC entries for examples which do not have readthedocs descriptions so suppressing to avoid the + warning: + WARNING: document isn't included in any toctree [toc.not_included] + If readthedocs description is added, these should be integrated into that description. + +.. toctree:: + :hidden: + + openamp-system-reference/examples/legacy_apps/examples/nocopy_echo/README + openamp-system-reference/examples/legacy_apps/examples/rpmsg_sample_echo/README + openamp-system-reference/examples/libmetal/README + openamp-system-reference/examples/libmetal/demos/irq_shmem_demo/README + openamp-system-reference/examples/libmetal/demos/irq_shmem_demo/host/README + openamp-system-reference/examples/libmetal/demos/irq_shmem_demo/remote/README + openamp-system-reference/examples/zephyr/dual_qemu_ivshmem/README From 53ec62729c13f576e568d285f642ad51b9cb75b2 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 07:29:35 +1000 Subject: [PATCH 10/19] conf: do not include hidden tocs in side bar by default all toc entries via toctree:: are included into the sidebar, including hidden ones which spams the menu, so set includehidden to false in the theme options. Signed-off-by: Sipke Vriend --- conf.py | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/conf.py b/conf.py index 3c336c6..af52ac6 100644 --- a/conf.py +++ b/conf.py @@ -119,7 +119,8 @@ html_logo = '_static/images/openAMP_combox_dark_trim.svg' html_theme_options = { - 'logo_only': True + 'logo_only': True, + 'includehidden': False } # below copied / hacked from Zephyr projects' zephyr/doc/conf.py From b3dc08c2b7df7c8dd3b47838844cc98caab4f0cf Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 09:00:46 +1000 Subject: [PATCH 11/19] demos: integrate readmes from hypervisorless_virtio_zcu102 Integrate the build and reference documentation from the hypervisorless virtio repository into the demo. Signed-off-by: Sipke Vriend --- demos/hvl_virtio.rst | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/demos/hvl_virtio.rst b/demos/hvl_virtio.rst index 5ae94dd..e24790a 100644 --- a/demos/hvl_virtio.rst +++ b/demos/hvl_virtio.rst @@ -99,6 +99,17 @@ This Hypervisorless Virtio Samples are demonstrated in the following reference i For information on building and running the demonstrations for zcu102 refer to .. toctree:: - :maxdepth: 2 + :maxdepth: 1 ../hypervisorless_virtio_zcu102/README_demo + ../hypervisorless_virtio_zcu102/README + ../hypervisorless_virtio_zcu102/zephyr_r5/README + ../hypervisorless_virtio_zcu102/zephyr_r5/hello_r5/README + +For more information on Hypervisorless Virtio and associated OpenAMP support refer to + +.. toctree:: + :maxdepth: 1 + + ../hypervisorless_virtio_zcu102/README_hypervisorless_virtio.md + ../hypervisorless_virtio_zcu102/README_openamp_virtio.md From 056d5751f415986934e592c7956174a8f30c0023 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 09:42:28 +1000 Subject: [PATCH 12/19] index: hide the open-amp and library readme files the open-amp and libmetal repository doxygen documentation, including readme files are included via the reference link in the navigation bar on the left, so list them as hidden in the main index. Signed-off-by: Sipke Vriend --- index.rst | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/index.rst b/index.rst index dd2d3e4..03c686d 100644 --- a/index.rst +++ b/index.rst @@ -22,6 +22,8 @@ Welcome to the OpenAMP Project Documentation .. 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] + Note that each library's (e.g. open-amp) readme file is included via the REFERENCE section links + in the navigation bar on the left. .. toctree:: :hidden: @@ -29,7 +31,12 @@ Welcome to the OpenAMP Project Documentation openamp-system-reference/README openamp-system-reference/LICENSE openamp-docs/README - + open-amp/.github/actions/build_ci/README + open-amp/README + open-amp/LICENSE + libmetal/.github/actions/build_ci/README + libmetal/README + libmetal/LICENSE .. TOC entries for examples which do not have readthedocs descriptions so suppressing to avoid the From 5877782c0bc10692eddda5ed1ab8b4d8feadff6a Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 09:43:27 +1000 Subject: [PATCH 13/19] index: hide the openamp-docs readme file the readme file for openamp-docs is only for how to generate these docs so hide it to avoid invalid warning that it is missing from table of contents. Signed-off-by: Sipke Vriend --- index.rst | 1 + 1 file changed, 1 insertion(+) diff --git a/index.rst b/index.rst index 03c686d..2b38143 100644 --- a/index.rst +++ b/index.rst @@ -28,6 +28,7 @@ Welcome to the OpenAMP Project Documentation .. toctree:: :hidden: + README openamp-system-reference/README openamp-system-reference/LICENSE openamp-docs/README From 341780fa08beab1619e5dc67600e180f49fbd873 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 09:46:10 +1000 Subject: [PATCH 14/19] index: hide maintainers file from table of contents Proposing to include these maintainers files through the reference link in the navigation bar on the left, whence we can hid them from the table of contents in the openamp-docs repository. Two additional pull requests would be made to open-amp and libmetal to support this. Signed-off-by: Sipke Vriend --- index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/index.rst b/index.rst index 2b38143..c4c541e 100644 --- a/index.rst +++ b/index.rst @@ -34,9 +34,11 @@ Welcome to the OpenAMP Project Documentation openamp-docs/README open-amp/.github/actions/build_ci/README open-amp/README + open-amp/MAINTAINERS open-amp/LICENSE libmetal/.github/actions/build_ci/README libmetal/README + libmetal/MAINTAINERS libmetal/LICENSE .. From e7c0aa3a7c3f369a45cc5c36a0d81e1129261812 Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 12:41:16 +1000 Subject: [PATCH 15/19] index: hide lopper repository specific documentation files hide from table of contenst the readme files in the lopper repository which detail what is in that repository and how to test rather than are actual documentation. This removes the toc.notincluded warning as that content isn't inside any readthedocs documentation. Signed-off-by: Sipke Vriend --- index.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/index.rst b/index.rst index c4c541e..537f9ef 100644 --- a/index.rst +++ b/index.rst @@ -40,6 +40,10 @@ Welcome to the OpenAMP Project Documentation libmetal/README libmetal/MAINTAINERS libmetal/LICENSE + lopper/LICENSE + lopper/specification/README + lopper/tests/MIGRATION_GUIDE + lopper/tests/README .. TOC entries for examples which do not have readthedocs descriptions so suppressing to avoid the From 1c41fedf78f3f506f0410bb329d028623e7dac9b Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 13:00:05 +1000 Subject: [PATCH 16/19] tools: rearrange lopper files and intergrate docs from lopper repo to enable the integration of the documentation in the lopper repository rearrange the files and tocs to make lopper a top leavel tool and add the repository documentation files as table of content entries. Signed-off-by: Sipke Vriend --- index.rst | 6 ++++++ tools/index.rst | 7 +++---- tools/lopper.rst | 44 +++--------------------------------------- tools/lopper_intro.rst | 43 +++++++++++++++++++++++++++++++++++++++++ 4 files changed, 55 insertions(+), 45 deletions(-) create mode 100644 tools/lopper_intro.rst diff --git a/index.rst b/index.rst index 537f9ef..a3540ca 100644 --- a/index.rst +++ b/index.rst @@ -44,6 +44,12 @@ Welcome to the OpenAMP Project Documentation lopper/specification/README lopper/tests/MIGRATION_GUIDE lopper/tests/README + lopper/README + lopper/README-architecture + lopper/specification/source/index + lopper/docs/amd/linux/source/index + lopper/docs/amd/zephyr/source/index + lopper/demos/openamp/README.md .. TOC entries for examples which do not have readthedocs descriptions so suppressing to avoid the diff --git a/tools/index.rst b/tools/index.rst index 4ad12ff..73ce45a 100644 --- a/tools/index.rst +++ b/tools/index.rst @@ -4,11 +4,10 @@ OpenAMP Supporting Tools ========================= +Lopper +------ + .. toctree:: :maxdepth: 2 - :caption: Contents: lopper - ../lopper/demos/openamp/README.md - -* Run the Lopper Demonstration as demo5 in :ref:`Docker Images`. diff --git a/tools/lopper.rst b/tools/lopper.rst index c75e2cb..2680e6a 100644 --- a/tools/lopper.rst +++ b/tools/lopper.rst @@ -1,44 +1,6 @@ -=================== -OpenAMP Lopper Tool -=================== -.. _lopper-tool-intro: -*************** -Lopper Intro -*************** +.. toctree:: + :maxdepth: 1 -System Device Trees (S-DT) are used to describe resources of `heterogeneous `_ embedded environments. - -Their intent is to be the industry standard method for defining how computing resources are divided into independent :ref:`runtime domains`. - -Examples of domains are - -* a computing unit, e.g. RTOS on R5s -* an operating environment at a specific execution level (e.g. `OPTEE `_) -* a virtual machine (e.g. `Xen `_) - -For those familiar with `Device Trees (DTS) `_ think of the S-DT as a combination of multiple device trees to define sub-systems. DTS' define resources seen from one address space, whereas S-DT's define the topology of the full system. - -The `Lopper Tool `_ provides a way to generate sub-system DTS' from S-DT's and manipulate, inspect or verify the S-DT for correctness. - -.. image:: ../images/tools/lopper-intro.svg - - -The `Lopper Tool `_ is a data driven tool written in Python, and supports inputs in dts, dtb and yaml format. Actions, which are used to manipulate the input data, are provided as unit operations (lops) as DTS formatted files. These are small transformation commands, inline Python source or for more complex scenarios `lopper assists `_ Python modules. - -The diagram below shows an example of three transformations performed by lopper through three independent DTS files which define the actions to perform. - -.. image:: ../images/tools/lopper-actions.svg - -Lopper is built on top of device tree tools, `Device Tree Compiler (DTC) `_ and `libfdt `_. - - -References -^^^^^^^^^^ - -:ref:`Lopper Architecture Readme` - -`Linaro Connect 2020 - System Device Tree & Lopper Slide Set `_ - -`Open Source Summit 2022 Slide Set `_ + lopper_intro diff --git a/tools/lopper_intro.rst b/tools/lopper_intro.rst new file mode 100644 index 0000000..d2fd976 --- /dev/null +++ b/tools/lopper_intro.rst @@ -0,0 +1,43 @@ + +.. _lopper-tool-intro: + +==================== +OpenAMP Lopper Intro +==================== + +System Device Trees (S-DT) are used to describe resources of `heterogeneous `_ embedded environments. + +Their intent is to be the industry standard method for defining how computing resources are divided into independent :ref:`runtime domains`. + +Examples of domains are + +* a computing unit, e.g. RTOS on R5s +* an operating environment at a specific execution level (e.g. `OPTEE `_) +* a virtual machine (e.g. `Xen `_) + +For those familiar with `Device Trees (DTS) `_ think of the S-DT as a combination of multiple device trees to define sub-systems. DTS' define resources seen from one address space, whereas S-DT's define the topology of the full system. + +The `Lopper Tool `_ provides a way to generate sub-system DTS' from S-DT's and manipulate, inspect or verify the S-DT for correctness. + +.. image:: ../images/tools/lopper-intro.svg + + +The `Lopper Tool `_ is a data driven tool written in Python, and supports inputs in dts, dtb and yaml format. Actions, which are used to manipulate the input data, are provided as unit operations (lops) as DTS formatted files. These are small transformation commands, inline Python source or for more complex scenarios `lopper assists `_ Python modules. + +The diagram below shows an example of three transformations performed by lopper through three independent DTS files which define the actions to perform. + +.. image:: ../images/tools/lopper-actions.svg + +Lopper is built on top of device tree tools, `Device Tree Compiler (DTC) `_ and `libfdt `_. + +Run the Lopper Demonstration as demo5 in :ref:`Docker Images`. + + +References +^^^^^^^^^^ + +`Linaro Connect 2020 - System Device Tree & Lopper Slide Set `_ + +`Open Source Summit 2022 Slide Set `_ + +`Lopper Repository `_ From 1197e6512dfa481a1fd3698917fe9f90e7e89c2c Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 9 Mar 2026 16:09:39 +1000 Subject: [PATCH 17/19] Remove invalid readme file remove non existent openamp-docs/README as it is already in there as README at base directory. Signed-off-by: Sipke Vriend --- index.rst | 1 - 1 file changed, 1 deletion(-) diff --git a/index.rst b/index.rst index a3540ca..36bced8 100644 --- a/index.rst +++ b/index.rst @@ -31,7 +31,6 @@ Welcome to the OpenAMP Project Documentation README openamp-system-reference/README openamp-system-reference/LICENSE - openamp-docs/README open-amp/.github/actions/build_ci/README open-amp/README open-amp/MAINTAINERS From b372fe0c3dc59c17d9fe5a3b0002d57f68edfbfa Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 16 Mar 2026 13:24:13 +1000 Subject: [PATCH 18/19] overview: remove duplicate reference and invalid indent warnings two references were labelled Virtio so change second to Virtio Driver to avoid the warning. WARNING: Duplicate explicit target name: "virtio". Add new lines after bullet point sections to avoid error. ERROR: Unexpected indentation. [docutils] Signed-off-by: Sipke Vriend --- openamp/overview.rst | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/openamp/overview.rst b/openamp/overview.rst index 49f68b4..397711d 100644 --- a/openamp/overview.rst +++ b/openamp/overview.rst @@ -283,17 +283,19 @@ This is achieved through the OpenAMP library which: (`See OpenAMP repository `_) - works on different system thanks to the `libmetal `_ adaptation layer: + - Bare Metal (No OS) - Multiple RTOS's, including `FreeRTOS `_, `NuttX `_, `Zephyr `_, `VxWorks `_, and more + - OS's on top of hypervisors - Within hypervisors - is compatible with different compilers such as gcc, clang, armcc and more - maintains compatibility with the Linux kernel by leveraging the following frameworks: `remoteproc `_, `RPMsg `_ and - `Virtio `_ frameworks. + `Virtio Driver `_ frameworks. .. _governance-work-label: From 26cd40a1ca14ec0a8995bc4046e5fc44483361dc Mon Sep 17 00:00:00 2001 From: Sipke Vriend Date: Mon, 16 Mar 2026 13:52:46 +1000 Subject: [PATCH 19/19] wip: temporary bump of gitmodule for demonstration purposes. This is part of draft pull request. Do not merge. provide gitmodule reference from sipke's forked repository to show the openamp-system-reference readme integrations into readthedocs. will delete once reviewed and submit PR as not draft. Signed-off-by: Sipke Vriend --- .gitmodules | 10 +++++----- hypervisorless_virtio_zcu102 | 2 +- libmetal | 2 +- lopper | 2 +- open-amp | 2 +- openamp-system-reference | 2 +- 6 files changed, 10 insertions(+), 10 deletions(-) diff --git a/.gitmodules b/.gitmodules index d62f42f..194d219 100644 --- a/.gitmodules +++ b/.gitmodules @@ -1,18 +1,18 @@ [submodule "open-amp"] path = open-amp - url = https://github.com/OpenAMP/open-amp.git + url = https://github.com/sipke/open-amp.git [submodule "hypervisorless_virtio_zcu102"] path = hypervisorless_virtio_zcu102 - url = https://github.com/danmilea/hypervisorless_virtio_zcu102.git + url = https://github.com/sipke/hypervisorless_virtio_zcu102.git [submodule "lopper"] path = lopper - url = https://github.com/devicetree-org/lopper.git + url = https://github.com/sipke/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 + url = https://github.com/sipke/libmetal.git [submodule "awesome"] path = _doxygen/awesome url = https://github.com/jothepro/doxygen-awesome-css.git diff --git a/hypervisorless_virtio_zcu102 b/hypervisorless_virtio_zcu102 index f2f5f79..d3c6321 160000 --- a/hypervisorless_virtio_zcu102 +++ b/hypervisorless_virtio_zcu102 @@ -1 +1 @@ -Subproject commit f2f5f7992da9a9c87d5e547537ba2e96be2d6ded +Subproject commit d3c6321d9df4af2b61889a36489ed44cfe76db92 diff --git a/libmetal b/libmetal index ece95f0..d59b83a 160000 --- a/libmetal +++ b/libmetal @@ -1 +1 @@ -Subproject commit ece95f0e71811c44a4c23d9a1514f338ccf60c75 +Subproject commit d59b83a800d24c1c4213a5e305f71312471e63bf diff --git a/lopper b/lopper index 2440a0c..2c9142c 160000 --- a/lopper +++ b/lopper @@ -1 +1 @@ -Subproject commit 2440a0ce358031a5b2874b31e4dbf7adf50392b8 +Subproject commit 2c9142cacaa00cde1fac5f7d000652f407c92547 diff --git a/open-amp b/open-amp index 59e843f..07d5036 160000 --- a/open-amp +++ b/open-amp @@ -1 +1 @@ -Subproject commit 59e843f3efd788c181436066298a3e03273bc4a1 +Subproject commit 07d50365fc5fc31dd3f78eeabd1c50185dcdd073 diff --git a/openamp-system-reference b/openamp-system-reference index 3eec8f8..12a89a3 160000 --- a/openamp-system-reference +++ b/openamp-system-reference @@ -1 +1 @@ -Subproject commit 3eec8f826a2f7fd5b3028bfdbe8253e00ec87f0c +Subproject commit 12a89a3f5b2310cec703fccaee470e057ce948a0