Enhance project and library aims #79
Conversation
|
Hi @sipke, I saw that you have one commit name WIP. you can change the PR in draft if not ready for the review ( "Convert to draft" link on the page). |
edmooring
left a comment
edmooring
left a comment
There was a problem hiding this comment.
Aside from the one grammar nit, this is good to go.
openamp/overview.rst
Outdated
| `OpenAMP Project Page <https://www.openampproject.org/governance/>`_. | ||
|
|
||
| There are a few guiding principles that governs OpenAMP: | ||
| There are a few guiding principles, based on the :ref:`project aims<project-aims>` that governs OpenAMP: |
There was a problem hiding this comment.
Grammar nit:
governs -> govern
sipke
force-pushed
the
feature/enhance-project-aims
branch
from
b4ce6c9 to
935bfe2
Compare
openamp/overview.rst
Outdated
| system through open source solutions for Asymmetric MultiProcessing (AMP)" | ||
| [`1 <https://www.openampproject.org/docs/OpenAMPProject_Charter_Approved2024AugEmailVote.pdf>`_]. | ||
|
|
||
| - "providing a clean-room open source implementation" |
There was a problem hiding this comment.
Implementation of what? How about:
providing a clean-room open source implementation of the above standards
The project also provides a third effort in the openamp-system-reference project which I would describe as:
a set of reference integrations into several common operating environments on multiple vendor platforms
openamp/overview.rst
Outdated
| * An open source project that implements a clean-room implementation of OpenAMP | ||
| - Runs in :ref:`multiple environments<operating-environments-work-label>` | ||
| - BSD License | ||
| The project also provides demos and promotes member and community collaboration on compatible |
There was a problem hiding this comment.
Not a fan of the word "demos" here, how about "examples", or maybe just drop it out and move the mention of "examples" up into the item on openamp-system-reference above, where all the examples should live.
There was a problem hiding this comment.
as suggested, dropped, as new aim about openamp-system-reference covers this
sipke
force-pushed
the
feature/enhance-project-aims
branch
from
935bfe2 to
77ed984
Compare
openamp/overview.rst
Outdated
| OpenAMP project is divided into the following efforts: | ||
| The `OpenAMP Project <https://www.openampproject.org>`_ is primarily focused on these efforts: | ||
|
|
||
| - "standardize the interactions between operating environments in a heterogeneous embedded |
There was a problem hiding this comment.
I wonder if the term "standardize" is not too strong. Indeed the OpenAMP project is not a standardization comity.
suggestion
Promote the standardization of the interactions between operating environments in a heterogeneous embedded
There was a problem hiding this comment.
I don't think standardize is too strong, but understand your point so added "seeks to" which was in the original quote of the linked source. Hopefully that softens so we can maintain the reference.
openamp/overview.rst
Outdated
| * An open source project that implements a clean-room implementation of OpenAMP | ||
| - Runs in :ref:`multiple environments<operating-environments-work-label>` | ||
| - BSD License | ||
| The project promotes reuse and its components are "Based on the existing open source |
There was a problem hiding this comment.
What means "reuse" here ? The term seems to me not clear?
Does it mean "portable on multi platform" , "open source solution" , other?
There was a problem hiding this comment.
The reuse is intended to refer directly to the quoted text, i.e. reuse of existing open source implementations. As it causes confusion, have removed the term and just leave the quote.
Reword project aims and include links to the openampproject.org page also to tie the two sets of information as the information is related. Issue OpenAMP#62 Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
Reword operating environment to focus on library, with slightly modified suggestion made by Arnaud in PR OpenAMP#61 Issue OpenAMP#62 Signed-off-by: Sipke Vriend <sipke@direktembedded.com>
sipke
force-pushed
the
feature/enhance-project-aims
branch
from
77ed984 to
82a4d06
Compare
4 participants
Attempt to address issue #62
Reword project aims and include links to the openampproject.org page also to tie the two sets of information as the information is related.
Reword operating environment to focus on library, with slightly modified suggestion made by Arnaud in PR #61