-
Notifications
You must be signed in to change notification settings - Fork 43
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[20401] Improve History QoS documentation and compatibility rules #664
Conversation
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
f4fa8ce
to
15a0280
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice docs inclusions. Also, thanks for refactoring the C++ code tester examples in the file to the latest format.
I left some NITs and a couple of suggestions.
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM with green CI
@Mergifyio backport 2.12.x 2.11.x 2.10.x 2.6.x |
✅ Backports have been created
|
* Refs #20401: Improve History documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update example to out last standard tabs format Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update all file examples Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Add NIT to explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Fix doc tab Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply spaces rev suggestion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation update based on internal discussion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Remove old explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Improve documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply NIT Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 157375d)
* Refs #20401: Improve History documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update example to out last standard tabs format Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update all file examples Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Add NIT to explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Fix doc tab Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply spaces rev suggestion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation update based on internal discussion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Remove old explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Improve documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply NIT Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 157375d)
* Refs #20401: Improve History documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update example to out last standard tabs format Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update all file examples Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Add NIT to explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Fix doc tab Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply spaces rev suggestion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation update based on internal discussion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Remove old explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Improve documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply NIT Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 157375d)
* Refs #20401: Improve History documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update example to out last standard tabs format Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update all file examples Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Add NIT to explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Fix doc tab Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply spaces rev suggestion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation update based on internal discussion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Remove old explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Improve documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply NIT Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 157375d) # Conflicts: # docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst
* Refs #20401: Improve History documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update example to out last standard tabs format Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update all file examples Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Add NIT to explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Fix doc tab Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply spaces rev suggestion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation update based on internal discussion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Remove old explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Improve documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply NIT Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 157375d) Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com>
) (#674) * Improve History QoS documentation and compatibility rules (#664) * Refs #20401: Improve History documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update example to out last standard tabs format Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update all file examples Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Add NIT to explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Fix doc tab Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply spaces rev suggestion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation update based on internal discussion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Remove old explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Improve documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply NIT Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 157375d) * Clarify depth vs max_samples_per_instance inconsistency (#679) Signed-off-by: EduPonz <eduardoponz@eprosima.com> --------- Signed-off-by: EduPonz <eduardoponz@eprosima.com> Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com> Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
* Improve History QoS documentation and compatibility rules (#664) * Refs #20401: Improve History documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update example to out last standard tabs format Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Update all file examples Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Add NIT to explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Fix doc tab Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply spaces rev suggestion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation rev suggestions Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply documentation update based on internal discussion Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Remove old explanation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Improve documentation Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Refs #20401: Apply NIT Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> (cherry picked from commit 157375d) # Conflicts: # docs/fastdds/dds_layer/core/policy/standardQosPolicies.rst * Refs #20401: Fix conlficts Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> * Clarify depth vs max_samples_per_instance inconsistency (#679) Signed-off-by: EduPonz <eduardoponz@eprosima.com> --------- Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com> Signed-off-by: EduPonz <eduardoponz@eprosima.com> Co-authored-by: Jesús Poderoso <120394830+JesusPoderoso@users.noreply.github.com> Co-authored-by: JesusPoderoso <jesuspoderoso@eprosima.com> Co-authored-by: Eduardo Ponz Segrelles <eduardoponz@eprosima.com>
This PR follows improves the History QoS configuration documentation and give some extra light regarding specific scenarios and compatibility with other QoS.
Note: This PR also updates the code / XML examples to the latest style followed in the documentation, as in continuous improvement.
Fast DDS related PR:
Fixes eProsima/Fast-DDS#4365