From 8856e728aece25678750a4b14eadecef17da342c Mon Sep 17 00:00:00 2001
From: Mabel Zhang <mabel@openrobotics.org>
Date: Wed, 21 Oct 2020 16:48:59 -0400
Subject: [PATCH] document deprecation of playback <path> SDF param (#425)

Signed-off-by: Mabel Zhang <mabel@openrobotics.org>
---
 Migration.md                     | 3 +++
 examples/worlds/log_playback.sdf | 5 +++++
 tutorials/log.md                 | 3 +++
 3 files changed, 11 insertions(+)

diff --git a/Migration.md b/Migration.md
index 5d686ba8bd..d47b4b02be 100644
--- a/Migration.md
+++ b/Migration.md
@@ -32,6 +32,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.
diff --git a/examples/worlds/log_playback.sdf b/examples/worlds/log_playback.sdf
index 56a25e9032..9194fb432f 100644
--- a/examples/worlds/log_playback.sdf
+++ b/examples/worlds/log_playback.sdf
@@ -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,
@@ -15,6 +18,8 @@
     <plugin
       filename='libignition-gazebo-log-system.so'
       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>
diff --git a/tutorials/log.md b/tutorials/log.md
index d120bf2471..16875c7c43 100644
--- a/tutorials/log.md
+++ b/tutorials/log.md
@@ -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`: