Skip to content
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

Merged
merged 11 commits into from
Feb 20, 2024

Conversation

JesusPoderoso
Copy link
Contributor

@JesusPoderoso JesusPoderoso commented Feb 14, 2024

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

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>
Copy link
Member

@Mario-DL Mario-DL left a 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>
@JesusPoderoso JesusPoderoso added the implementation-pending Marks doc PRs which corresponding implementation is not yet available on Fast DDS label Feb 20, 2024
Signed-off-by: JesusPoderoso <jesuspoderoso@eprosima.com>
Copy link
Member

@Mario-DL Mario-DL left a 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

@JesusPoderoso JesusPoderoso added ci-pending ready-to-merge and removed implementation-pending Marks doc PRs which corresponding implementation is not yet available on Fast DDS ci-pending labels Feb 20, 2024
@EduPonz EduPonz merged commit 157375d into master Feb 20, 2024
4 of 5 checks passed
@EduPonz EduPonz deleted the hotfix/history_depth_bounds branch February 20, 2024 13:34
@EduPonz
Copy link

EduPonz commented Feb 20, 2024

@Mergifyio backport 2.12.x 2.11.x 2.10.x 2.6.x

Copy link

mergify bot commented Feb 20, 2024

backport 2.12.x 2.11.x 2.10.x 2.6.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Feb 20, 2024
* 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)
mergify bot pushed a commit that referenced this pull request Feb 20, 2024
* 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)
mergify bot pushed a commit that referenced this pull request Feb 20, 2024
* 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)
mergify bot pushed a commit that referenced this pull request Feb 20, 2024
* 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
MiguelCompany pushed a commit that referenced this pull request Feb 21, 2024
* 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>
elianalf pushed a commit that referenced this pull request Mar 13, 2024
) (#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>
Mario-DL pushed a commit that referenced this pull request Apr 16, 2024
* 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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

SIGABRT while receiving data on specific HistoryQosPolicy depth setting
3 participants