[22012] Update migration guide removing things not related to application developer #1003
Conversation
Signed-off-by: Juanjo Garcia <[email protected]>
Signed-off-by: Juanjo Garcia <[email protected]>
Signed-off-by: Juanjo Garcia <[email protected]>
Signed-off-by: Juanjo Garcia <[email protected]>
Signed-off-by: Juanjo Garcia <[email protected]>
juanjo4936
force-pushed
the
fix/update-migration-guide
branch
from
3378e09 to
1cd570e
Compare
| Also, the ``fixed_size_string.hpp`` implementation has been migrated from ``fastrtps/utils/fixed_size_string.hpp`` | ||
| to ``fastcdr/cdr/fixed_size_string.hpp``. | ||
|
|
||
| .. TODO:: Fix this table, ``fastdds/rtps/DomainParticipantQos.hpp`` has wrong path and doesn't include the content. |
There was a problem hiding this comment.
This file is not in this path, and doesn't match the content. I think maybe fastdds/dds/domain/qos/DomainParticipantExtendedQos.hpp? The class would then be DomainParticipantExtendedQos, a change that should be mentioned.
| @@ -209,6 +210,8 @@ If your project previously included any of these headers, you will need to modif | |||
| Since these headers are now private, you should replace their usage with public alternatives or refactor the | |||
| related code to ensure it does not depend on private headers. | |||
|
|
|||
| .. TODO:: Add a note about which headers to use instead of the private ones. | |||
|
|
|||
There was a problem hiding this comment.
I believe this is way too brief. Shouldn't we explain what they should include instead?
| @@ -396,6 +399,9 @@ your code to reflect these changes: | |||
| Step 9: Examples refactor | |||
| ^^^^^^^^^^^^^^^^^^^^^^^^^ | |||
|
|
|||
| .. TODO:: What to do here? Write which examples in 2 turned into which examples in 3? | |||
| A lot of the info seems too much. | |||
|
|
|||
There was a problem hiding this comment.
I have doubts the section itself is necessary. In any case, what would a user look for here? They would be trying to update the previous version, so the changes we made are not as important, right? I would imagine something like what Juan suggested, mention which examples in v2 became what examples in v3, to maintain their function. Note that it doesn't seem straightforward to me at all, given their naming changes.
Description
WIP: Modify the migration guide from Fast 2 to Fast 3. Eliminated some lines that referred to private files or internal tasks, and clarified a few points. Found many additional changes that might be necessary so I'm opening the pull request to discuss the extra changes.
@Mergifyio backport 3.1.x 3.0.x
Contributor Checklist
Reviewer Checklist