From fcc334d652b381dec42b982546432dc5ed21584c Mon Sep 17 00:00:00 2001
From: KongQun Yang <kqyang@google.com>
Date: Wed, 20 Dec 2017 12:26:23 -0800
Subject: [PATCH] [Doc] Fix a few problems

- Add --time_shift_buffer_depth to HLS doc.
- Fix a problem in HLS tutorial

Partially address #304, fixes #305

Change-Id: I60bc1eb659a30beb0a6ab73433f4cc99a7deab07
---
 docs/source/options/hls_options.rst |  5 +++++
 docs/source/tutorials/hls.rst       | 10 +++++-----
 packager/app/packager_main.cc       |  7 ++++---
 3 files changed, 14 insertions(+), 8 deletions(-)

diff --git a/docs/source/options/hls_options.rst b/docs/source/options/hls_options.rst
index 52969215e6..52bed9a071 100644
--- a/docs/source/options/hls_options.rst
+++ b/docs/source/options/hls_options.rst
@@ -21,3 +21,8 @@ HLS options
     VOD, EVENT, or LIVE. This defines the EXT-X-PLAYLIST-TYPE in the HLS
     specification. For hls_playlist_type of LIVE, EXT-X-PLAYLIST-TYPE tag is
     omitted.
+
+--time_shift_buffer_depth <seconds>
+
+    Guaranteed duration of the time shifting buffer for LIVE playlist, in
+    seconds.
diff --git a/docs/source/tutorials/hls.rst b/docs/source/tutorials/hls.rst
index 4baba4672c..0183796bee 100644
--- a/docs/source/tutorials/hls.rst
+++ b/docs/source/tutorials/hls.rst
@@ -46,11 +46,11 @@ The examples below uses the H264 streams created in :doc:`encoding`.
 * TS output::
 
     $ packager \
-      'in=h264_baseline_360p_600.mp4,stream=audio,output=audio_$Number$.ts,playlist_name=audio.m3u8,hls_group_id=audio,hls_name=ENGLISH' \
-      'in=h264_baseline_360p_600.mp4,stream=video,output=h264_360p_$Number$.ts,playlist_name=h264_360p.m3u8' \
-      'in=h264_main_480p_1000.mp4,stream=video,output=h264_480p_$Number$.ts,playlist_name=h264_480p.m3u8' \
-      'in=h264_main_720p_3000.mp4,stream=video,output=h264_720p_$Number$.ts,playlist_name=h264_720p.m3u8' \
-      'in=h264_high_1080p_6000.mp4,stream=video,output=h264_1080p_$Number$.ts,playlist_name=h264_1080p.m3u8' \
+      'in=h264_baseline_360p_600.mp4,stream=audio,segment_template=audio_$Number$.ts,playlist_name=audio.m3u8,hls_group_id=audio,hls_name=ENGLISH' \
+      'in=h264_baseline_360p_600.mp4,stream=video,segment_template=h264_360p_$Number$.ts,playlist_name=h264_360p.m3u8' \
+      'in=h264_main_480p_1000.mp4,stream=video,segment_template=h264_480p_$Number$.ts,playlist_name=h264_480p.m3u8' \
+      'in=h264_main_720p_3000.mp4,stream=video,segment_template=h264_720p_$Number$.ts,playlist_name=h264_720p.m3u8' \
+      'in=h264_high_1080p_6000.mp4,stream=video,segment_template=h264_1080p_$Number$.ts,playlist_name=h264_1080p.m3u8' \
       --hls_master_playlist_output h264_master.m3u8
 
 The above packaging command creates five single track TS streams
diff --git a/packager/app/packager_main.cc b/packager/app/packager_main.cc
index 333a90f250..1968d7f21e 100644
--- a/packager/app/packager_main.cc
+++ b/packager/app/packager_main.cc
@@ -96,9 +96,10 @@ const char kUsage[] =
     "    EXT-X-MEDIA. Defaults to the base of the playlist name.\n"
     "  - hls_group_id: Used for HLS audio to set the GROUP-ID attribute for\n"
     "    EXT-X-MEDIA. Defaults to 'audio' if not specified.\n"
-    "  - playlist_name: Used for HLS video. The name of the playlist to create.\n"
-    "    Usually ends with '.m3u8'. If unspecified, defaults to something of\n"
-    "    the form 'stream_0.m3u8', 'stream_1.m3u8', 'stream_2.m3u8', etc.\n";
+    "  - playlist_name: The HLS playlist file to create. Usually ends with\n"
+    "    '.m3u8', and is relative to --hls_master_playlist_output. If\n"
+    "    unspecified, defaults to something of the form 'stream_0.m3u8',\n"
+    "    'stream_1.m3u8', 'stream_2.m3u8', etc.\n";
 
 // Labels for parameters in RawKey key info.
 const char kDrmLabelLabel[] = "label";