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.

Sign up for GitHub

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

[Citadel] Document deprecation of playback <path> SDF param #424

Merged
merged 1 commit into from
Oct 21, 2020
Merged

[Citadel] Document deprecation of playback <path> SDF param #424

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions Migration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,9 @@ Gazebo 2+ for playback. [BitBucket pull request
#257](https://osrf-migration.github.io/ignition-gh-pages/#!/ignitionrobotics/ign-gazebo/pull-requests/257)
added an SDF message to the start of log files.

* Log playback using `<path>` SDF parameter is deprecated. Use `--playback`
command line argument instead.

## Ignition Gazebo 1.0.2 to 1.1.0

* All headers in `gazebo/network` are no longer installed.
Expand Down
5 changes: 5 additions & 0 deletions examples/worlds/log_playback.sdf
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@
<!--
Log playback demo.

This file will be removed in Ignition Dome. Use the command line argument
for playback instead.

Running this world will playback log files located at /tmp/log.

You can record such a log by running one of the `log_record*.sdf` files,
Expand All @@ -15,6 +18,8 @@
<plugin
filename='ignition-gazebo-log-system'
name='ignition::gazebo::systems::LogPlayback'>
<!-- Deprecation warning: This parameter will be removed in Ignition Dome.
Use the command line argument for playback instead. -->
<path>/tmp/log</path>
</plugin>
</world>
Expand Down
3 changes: 3 additions & 0 deletions tutorials/log.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,9 @@ directory specified to record:

### From plugin in SDF

This feature is deprecated and will be removed in Ignition Dome.
Use the command line argument instead.

Alternatively, playback can be specified in an SDF file. See example file
`examples/worlds/log_playback.sdf`:

Expand Down