From 764c7077a2c9d0f99ec7db248649909392a4b519 Mon Sep 17 00:00:00 2001 From: KongQun Yang Date: Wed, 2 May 2018 10:55:51 -0700 Subject: [PATCH] Fix documentation syntaxes for RST option-list http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#option-lists RST only accepts two forms for option argument: - Begins with a letter and consists of [a-zA-Z0-9_]. - Begins with "<" and ends with ">"; any characters except angle brackets are allowed internally. Updated documents to obey the above rule. Also cleaned up the documents to follow the syntaxes defined in http://docopt.org/. Change-Id: I06c6fa6db524325373053b26fc99169469664f01 --- docs/source/documentation.rst | 12 ++++----- docs/source/options/dash_options.rst | 27 +++++++++++-------- .../options/raw_key_encryption_options.rst | 2 +- docs/source/options/stream_descriptors.rst | 2 +- docs/source/options/udp_file_options.rst | 8 +++--- docs/source/tutorials/dash.rst | 4 +-- docs/source/tutorials/hls.rst | 5 ++-- docs/source/tutorials/raw_key.rst | 8 +++--- docs/source/tutorials/widevine.rst | 4 +-- 9 files changed, 38 insertions(+), 34 deletions(-) diff --git a/docs/source/documentation.rst b/docs/source/documentation.rst index f9d7c74377..22b3cbc09f 100644 --- a/docs/source/documentation.rst +++ b/docs/source/documentation.rst @@ -34,7 +34,7 @@ Synopsis :: - $ packager {stream_descriptor} [{stream_descriptor}] ... \ + $ packager ... \ [--dump_stream_info] \ [Chunking Options] \ [MP4 Output Options] \ @@ -65,11 +65,11 @@ Different key providers cannot be specified at the same time. :: - [--enable_widevine_encryption {Widevine Encryption Options}] \ - [--enable_widevine_decryption {Widevine Decryption Options}] \ - [--enable_raw_key_encryption {Raw Key Encryption Options}] \ - [--enable_raw_key_decryption {Raw Key Decryption Options}] \ - [--enable_playready_encryption {PlayReady Encryption Options}] + [--enable_widevine_encryption ] \ + [--enable_widevine_decryption ] \ + [--enable_raw_key_encryption ] \ + [--enable_raw_key_decryption ] \ + [--enable_playready_encryption ] .. include:: /options/general_encryption_options.rst diff --git a/docs/source/options/dash_options.rst b/docs/source/options/dash_options.rst index 16cfa3f083..87b3d4002c 100644 --- a/docs/source/options/dash_options.rst +++ b/docs/source/options/dash_options.rst @@ -9,31 +9,34 @@ DASH options that if segment_template is not specified, shaka-packager always generates static mpd regardless of the value of this flag. ---mpd_output {file_path} +--mpd_output MPD output file name. ---base_urls {url}[,{url}]... +--base_urls - Comma separated BaseURLs for the MPD. The values will be added as - element(s) immediately under the element. + Comma separated BaseURLs for the MPD: + **[,]...**. ---min_buffer_time {seconds} + The values will be added as element(s) immediately under the + element. + +--min_buffer_time Specifies, in seconds, a common duration used in the definition of the MPD Representation data rate. ---minimum_update_period {seconds} +--minimum_update_period Indicates to the player how often to refresh the media presentation description in seconds. This value is used for dynamic MPD only. ---suggested_presentation_delay {seconds} +--suggested_presentation_delay Specifies a delay, in seconds, to be added to the media presentation time. This value is used for dynamic MPD only. ---time_shift_buffer_depth {seconds} +--time_shift_buffer_depth Guaranteed duration of the time shifting buffer for dynamic media presentations, in seconds. @@ -48,12 +51,14 @@ DASH options The segments are not removed if the value is zero. ---utc_timing {scheme_id_uri}={value}[,{scheme_id_uri}={value}]... +--utc_timing + + Comma separated UTCTiming schemeIdUri and value pairs for the MPD: + **=[,=]...** - Comma separated UTCTiming schemeIdUri and value pairs for the MPD. This value is used for dynamic MPD only. ---default_language {language} +--default_language Any audio/text tracks tagged with this language will have in the manifest. This allows the player to diff --git a/docs/source/options/raw_key_encryption_options.rst b/docs/source/options/raw_key_encryption_options.rst index 6beae951a1..cdda7ee32e 100644 --- a/docs/source/options/raw_key_encryption_options.rst +++ b/docs/source/options/raw_key_encryption_options.rst @@ -13,7 +13,7 @@ Raw key encryption options **key_info_string** is of the form:: - label={label}:key_id={key_id}:key={key} + label=