Changes C for Issue 38 Remove future and current folders #43
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 20 commits
March 6, 2025 09:35
Refer issue 38: OpenAMP#38 Remove "once loaded and started using Remoteproc."
Refer issue 38: OpenAMP#38 Remove or set optional resource table in demo diagrams. replace remoteproc by remoteproc virtio in message diagrams. Change diagrom to use Main processor terminology for main/host computer.
Refer issue 38: OpenAMP#38 change reference to code from opena-amp repository to openamp-system repository
Refer issue 38: OpenAMP#38 Proxy and RPC chapter should be renamed Rpmsg service. Did not remove Proxy yet, as still "to discuss if we keep the proxy service that is not generic."
to avoid confusion between host and guest, move architecture and demo pages to use main controller and remote rather than host and remote.
Change "They allow the users" to user to correct grammar.
review request to use matrices spelling
address review from Arnaud "The diagram is not accurate for the ./rpmsg_export_dev usage. Between rpmsg_ctrl and app_rpmsg_tty, there is a Name Service (NS) RPmsg from the main processor to the remote processor(inverted on diagram). In other words, rpmsg_export_dev allows creating an rpmsg TTY (or raw) device instance on the main processor. In such a case, the main processor sends an NS rpmsg message to the remote processor to inform it of the creation. Another suggestion: To clarify the diagram, it would be helpful to add boxes or notes to separate and explain the subsequences. This would help readers understand the relation between the demos and the diagram."
Refer issue 38: OpenAMP#38 Address review comment: move "If you want to contribute and port OpenAMP to your platform read more about OpenAMP porting here." to contributing page
Refer issue 38: OpenAMP#38 Address review comment: add link to the virtio spec
Refer issue 38: OpenAMP#38 Address review comment: to rewrite this chapter ( remove standardization notions).
Most of this page is in governance, so remove most and leave only more specific links to other sections providing more specific details on how to contribute. Refer issue 38: OpenAMP#38 Addressing review comments: * Avoid duplication with https://www.openampproject.org/governance/ in this pages. to determine if a part of the gouvernance should be moved ghere * no roadmap defined, to remove chapter * no platform maintainer defined, to remove chapter and/or rewrite according to gouvernance page
Refer issue 38: OpenAMP#38 Address review comment: "History" to move to OpenAMp project part?
Refer issue 38: OpenAMP#38 Address review comments: * "input ring buffer" and "free ring buffer" is not really current terminology in Virtio lingo. Maybe just keep the standard used and available terminology. * It's not clear from the title of this image that it refers to the available ring buffer.
Refer issue 38: OpenAMP#38 Address review comment: * The fastest fix is to remove the last phrase which mentions the "referred to as a hypervisorless-virtio" statement.
Expand on the OpenAMP specific acronyms on first usage, so they make sense later in bullet points Address Review comment: * Following short-forms should be explained somewhere:
Add a link to glossary and start filling out a table of terms.
openamp examples are deprecated so move reference.
Refer issue 38: OpenAMP#38 Address review comment: NXP i.MX8M Plus is also supported.
These two folders look to have been a combination of work in progress and todo items. The pages do not seem accessible from the main content as neither index.rst files are in a toc, but content within them is searchable which results in the reader being able finding these pages. Remove to avoid confusion for near future and re-introduce content as needed.
sipke
changed the title
arnopo
approved these changes
Mar 25, 2025
28 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
cleanup: remove future and current folders
These two folders look to have been a combination of work in progress
and todo items.
The pages do not seem accessible from the main content as neither index.rst
files are in a toc, but content within them is searchable which
results in the reader being able to find these pages. Remove to avoid
confusion for near future and re-introduce content as needed.