From c45ab0634b9e4b8fbd1bc88ff13f21f554e94955 Mon Sep 17 00:00:00 2001
From: John Shepherd <john@openrobotics.org>
Date: Mon, 28 Sep 2020 10:46:41 -0700
Subject: [PATCH] Update log tutorials (#386)

Signed-off-by: John Shepherd <john@openrobotics.org>
---
 examples/worlds/log_playback.sdf            | 22 ---------------------
 examples/worlds/log_record_dbl_pendulum.sdf |  7 ++++---
 examples/worlds/log_record_keyboard.sdf     |  4 ++++
 examples/worlds/log_record_resources.sdf    | 15 ++++++++------
 examples/worlds/log_record_shapes.sdf       |  5 +++++
 5 files changed, 22 insertions(+), 31 deletions(-)
 delete mode 100644 examples/worlds/log_playback.sdf

diff --git a/examples/worlds/log_playback.sdf b/examples/worlds/log_playback.sdf
deleted file mode 100644
index f924f1208e..0000000000
--- a/examples/worlds/log_playback.sdf
+++ /dev/null
@@ -1,22 +0,0 @@
-<?xml version='1.0'?>
-<!--
-  Log playback demo.
-
-  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,
-  such as `log_record_dbl_pendulum`.
--->
-<sdf version='1.6'>
-  <world name='default'>
-    <plugin filename='ignition-gazebo-scene-broadcaster-system'
-            name='ignition::gazebo::systems::SceneBroadcaster'>
-    </plugin>
-    <plugin
-      filename='ignition-gazebo-log-system'
-      name='ignition::gazebo::systems::LogPlayback'>
-      <path>/tmp/log</path>
-    </plugin>
-  </world>
-</sdf>
-
diff --git a/examples/worlds/log_record_dbl_pendulum.sdf b/examples/worlds/log_record_dbl_pendulum.sdf
index 0a964ee416..fdb457d22c 100644
--- a/examples/worlds/log_record_dbl_pendulum.sdf
+++ b/examples/worlds/log_record_dbl_pendulum.sdf
@@ -5,6 +5,10 @@
   Running this world will record log files to ~/.ignition/gazebo/log/<timestamp>
   by default.
 
+  Running `ign gazebo` with `-v 3` or `-v 4` will output a message indicating where
+  your logfile is being stored to (e.g., [Msg] Recording to log file 
+  [/home/username/.ignition/gazebo/log/<timestamp>/state.tlog]).
+
   You can playback the logs with:
 
       ign gazebo --playback ~/.ignition/gazebo/log/<timestamp>
@@ -31,9 +35,6 @@
     <plugin
       filename="ignition-gazebo-log-system"
       name="ignition::gazebo::systems::LogRecord">
-      <!-- Deprecated: directories to write recorded files.
-           Use --record-path instead. -->
-      <!--path>/tmp/log</path-->
     </plugin>
 
     <light type="directional" name="sun">
diff --git a/examples/worlds/log_record_keyboard.sdf b/examples/worlds/log_record_keyboard.sdf
index f8d55000cd..ba534c82fd 100644
--- a/examples/worlds/log_record_keyboard.sdf
+++ b/examples/worlds/log_record_keyboard.sdf
@@ -5,6 +5,10 @@
   Running this world will record log files to ~/.ignition/gazebo/log/<timestamp>
   by default.
 
+  Running `ign gazebo` with `-v 3` or `-v 4` will output a message indicating where
+  your logfile is being stored to (e.g., [Msg] Recording to log file 
+  [/home/username/.ignition/gazebo/log/<timestamp>/state.tlog]).
+
   Use the example program on examples/standalone/keyboard to control the vehicles.
 
   You can playback the logs with:
diff --git a/examples/worlds/log_record_resources.sdf b/examples/worlds/log_record_resources.sdf
index 254c1e4f09..d8ada02852 100644
--- a/examples/worlds/log_record_resources.sdf
+++ b/examples/worlds/log_record_resources.sdf
@@ -2,10 +2,16 @@
 <!--
   Log record resources demo.
 
-  Running this world will record log files to /tmp/log. It will overwrite that
-  directory if it already exists.
+  Running this world will record log files to ~/.ignition/gazebo/log/<timestamp>
+  by default.
 
-  You can playback running the log_playback.sdf file.
+  Running `ign gazebo` with `-v 3` or `-v 4` will output a message indicating where
+  your logfile is being stored to (e.g., [Msg] Recording to log file 
+  [/home/username/.ignition/gazebo/log/<timestamp>/state.tlog]).
+
+  You can playback the logs with:
+
+      ign gazebo --playback ~/.ignition/gazebo/log/<timestamp>
 -->
 <sdf version="1.6">
   <world name="default">
@@ -20,9 +26,6 @@
     <plugin
       filename="ignition-gazebo-log-system"
       name="ignition::gazebo::systems::LogRecord">
-      <!-- Deprecated: directories to write recorded files.
-           Use --record-path instead. -->
-      <!-- path>/tmp/log</path -->
       <record_resources>1</record_resources>
       <compress>0</compress>
     </plugin>
diff --git a/examples/worlds/log_record_shapes.sdf b/examples/worlds/log_record_shapes.sdf
index 60f9254254..5142d1ddeb 100644
--- a/examples/worlds/log_record_shapes.sdf
+++ b/examples/worlds/log_record_shapes.sdf
@@ -5,6 +5,11 @@
   Running this world will record log files to ~/.ignition/gazebo/log/<timestamp>
   by default.
 
+  Running `ign gazebo` with `-v 3` or `-v 4` will output a message indicating where
+  your logfile is being stored to (e.g., [Msg] Recording to log file 
+  [/home/username/.ignition/gazebo/log/<timestamp>/state.tlog]).
+
+
   You can playback the logs with:
 
       ign gazebo --playback ~/.ignition/gazebo/log/<timestamp>