Update log tutorials (#386)

Signed-off-by: John Shepherd <[email protected]>
gazebosim · Sep 28, 2020 · c45ab06 · c45ab06
1 parent ab0042e
commit c45ab06
Show file tree

Hide file tree

Showing 5 changed files with 22 additions and 31 deletions.
diff --git a/examples/worlds/log_playback.sdf b/examples/worlds/log_playback.sdf
diff --git 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
@@ -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
@@ -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
@@ -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>