[Citadel] Document deprecation of playback <path> SDF param #424
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
Signed-off-by: Mabel Zhang <[email protected]>
doisyg
pushed a commit
to wyca-robotics/ign-gazebo
that referenced
this pull request
Dec 13, 2020
Signed-off-by: Mabel Zhang <[email protected]> Signed-off-by: Guillaume Doisy <[email protected]>
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.
Documentation to address #293 for Citadel.
Discussed with @chapulina and we decided to do the following:
Blueprint & Citadel:
log_playback.sdfsince the distros have already been released and the file installed.<path>is not recommended.log_playback.sdfrather thanlog_record_*.sdf, because it's really the playback file that's being replaced, and they just have to use--playback [arg]. Nothing changes for recording.Migration.mdEssentially deprecate
<path>for Blueprint and Citadel, remove it in Dome.Will make followup PR for Blueprint.
Dome will be in a separate PR with different items -
log_playback.sdfhas already been removed in Dome, documentation needs to be updated, and some test code needs to be changed, so it'll take a bit longer.