From 10aeb7403f30ea34045d79f7cba0f3e7e962768c Mon Sep 17 00:00:00 2001 From: Johannes Kron Date: Fri, 6 Mar 2020 11:34:22 +0100 Subject: [PATCH] Rename index.md to README.md to make it automatically show up Also add a heading to each file. No-Try: True Bug: webrtc:11335 Change-Id: I5e935741662558e72e417fa80a48c5ecda66c5f3 Reviewed-on: https://webrtc-review.googlesource.com/c/src/+/169854 Reviewed-by: Mirko Bonadei Commit-Queue: Johannes Kron Cr-Commit-Position: refs/heads/master@{#30702} --- .../abs-capture-time/{index.md => README.md} | 2 ++ .../abs-send-time/{index.md => README.md} | 2 ++ .../color-space/{index.md => README.md} | 2 ++ .../inband-cn/{index.md => README.md} | 2 ++ docs/native-code/rtp-hdrext/index.md | 18 ++++++++++-------- .../playout-delay/{index.md => README.md} | 2 ++ .../{index.md => README.md} | 2 ++ .../video-content-type/{index.md => README.md} | 2 ++ .../video-timing/{index.md => README.md} | 4 +++- 9 files changed, 27 insertions(+), 9 deletions(-) rename docs/native-code/rtp-hdrext/abs-capture-time/{index.md => README.md} (99%) rename docs/native-code/rtp-hdrext/abs-send-time/{index.md => README.md} (98%) rename docs/native-code/rtp-hdrext/color-space/{index.md => README.md} (99%) rename docs/native-code/rtp-hdrext/inband-cn/{index.md => README.md} (99%) rename docs/native-code/rtp-hdrext/playout-delay/{index.md => README.md} (99%) rename docs/native-code/rtp-hdrext/transport-wide-cc-02/{index.md => README.md} (98%) rename docs/native-code/rtp-hdrext/video-content-type/{index.md => README.md} (97%) rename docs/native-code/rtp-hdrext/video-timing/{index.md => README.md} (96%) diff --git a/docs/native-code/rtp-hdrext/abs-capture-time/index.md b/docs/native-code/rtp-hdrext/abs-capture-time/README.md similarity index 99% rename from docs/native-code/rtp-hdrext/abs-capture-time/index.md rename to docs/native-code/rtp-hdrext/abs-capture-time/README.md index 5b429d73cd..171993c2e7 100644 --- a/docs/native-code/rtp-hdrext/abs-capture-time/index.md +++ b/docs/native-code/rtp-hdrext/abs-capture-time/README.md @@ -1,3 +1,5 @@ +# Absolute Capture Time + The Absolute Capture Time extension is used to stamp RTP packets with a NTP timestamp showing when the first audio or video frame in a packet was originally captured. The intent of this extension is to provide a way to accomplish diff --git a/docs/native-code/rtp-hdrext/abs-send-time/index.md b/docs/native-code/rtp-hdrext/abs-send-time/README.md similarity index 98% rename from docs/native-code/rtp-hdrext/abs-send-time/index.md rename to docs/native-code/rtp-hdrext/abs-send-time/README.md index 393b21a94d..86c3c733dc 100644 --- a/docs/native-code/rtp-hdrext/abs-send-time/index.md +++ b/docs/native-code/rtp-hdrext/abs-send-time/README.md @@ -1,3 +1,5 @@ +# Absolute Send Time + The Absolute Send Time extension is used to stamp RTP packets with a timestamp showing the departure time from the system that put this packet on the wire (or as close to this as we can manage). Contact for diff --git a/docs/native-code/rtp-hdrext/color-space/index.md b/docs/native-code/rtp-hdrext/color-space/README.md similarity index 99% rename from docs/native-code/rtp-hdrext/color-space/index.md rename to docs/native-code/rtp-hdrext/color-space/README.md index 7df029e9c9..3f9485681f 100644 --- a/docs/native-code/rtp-hdrext/color-space/index.md +++ b/docs/native-code/rtp-hdrext/color-space/README.md @@ -1,3 +1,5 @@ +# Color Space + The color space extension is used to communicate color space information and optionally also metadata that is needed in order to properly render a high dynamic range (HDR) video stream. Contact for more info. diff --git a/docs/native-code/rtp-hdrext/inband-cn/index.md b/docs/native-code/rtp-hdrext/inband-cn/README.md similarity index 99% rename from docs/native-code/rtp-hdrext/inband-cn/index.md rename to docs/native-code/rtp-hdrext/inband-cn/README.md index e20302596b..70ecdac0fb 100644 --- a/docs/native-code/rtp-hdrext/inband-cn/index.md +++ b/docs/native-code/rtp-hdrext/inband-cn/README.md @@ -1,3 +1,5 @@ +# Inband Comfort Noise + **Name:** "Inband Comfort Noise" ; "RTP Header Extension to signal inband comfort noise" **Formal name:** diff --git a/docs/native-code/rtp-hdrext/index.md b/docs/native-code/rtp-hdrext/index.md index f9aa9ac7a2..c0c0b75aba 100644 --- a/docs/native-code/rtp-hdrext/index.md +++ b/docs/native-code/rtp-hdrext/index.md @@ -1,10 +1,12 @@ +# Experimental RTP header extensions + The following subpages define experiemental RTP header extensions: - * [abs-send-time](abs-send-time/index.md) - * [abs-capture-time](abs-capture-time/index.md) - * [color-space](color-space/index.md) - * [playout-delay](playout-delay/index.md) - * [transport-wide-cc-02](transport-wide-cc-02/index.md) - * [video-content-type](video-content-type/index.md) - * [video-timing](video-timing/index.md) - * [inband-cn](inband-cn/index.md) + * [abs-send-time](abs-send-time/README.md) + * [abs-capture-time](abs-capture-time/README.md) + * [color-space](color-space/README.md) + * [playout-delay](playout-delay/README.md) + * [transport-wide-cc-02](transport-wide-cc-02/README.md) + * [video-content-type](video-content-type/README.md) + * [video-timing](video-timing/README.md) + * [inband-cn](inband-cn/README.md) diff --git a/docs/native-code/rtp-hdrext/playout-delay/index.md b/docs/native-code/rtp-hdrext/playout-delay/README.md similarity index 99% rename from docs/native-code/rtp-hdrext/playout-delay/index.md rename to docs/native-code/rtp-hdrext/playout-delay/README.md index 45e769d50d..e669b04f83 100644 --- a/docs/native-code/rtp-hdrext/playout-delay/index.md +++ b/docs/native-code/rtp-hdrext/playout-delay/README.md @@ -1,3 +1,5 @@ +# Playout Delay + **Name:** "Playout Delay" ; "RTP Header Extension to control Playout Delay" **Formal name:** diff --git a/docs/native-code/rtp-hdrext/transport-wide-cc-02/index.md b/docs/native-code/rtp-hdrext/transport-wide-cc-02/README.md similarity index 98% rename from docs/native-code/rtp-hdrext/transport-wide-cc-02/index.md rename to docs/native-code/rtp-hdrext/transport-wide-cc-02/README.md index 443d073cc6..20b1d51dd2 100644 --- a/docs/native-code/rtp-hdrext/transport-wide-cc-02/index.md +++ b/docs/native-code/rtp-hdrext/transport-wide-cc-02/README.md @@ -1,3 +1,5 @@ +# Transport-Wide Congestion Control + This RTP header extension is an extended version of the extension defined in diff --git a/docs/native-code/rtp-hdrext/video-content-type/index.md b/docs/native-code/rtp-hdrext/video-content-type/README.md similarity index 97% rename from docs/native-code/rtp-hdrext/video-content-type/index.md rename to docs/native-code/rtp-hdrext/video-content-type/README.md index a8f549e14b..e7eb10d4e8 100644 --- a/docs/native-code/rtp-hdrext/video-content-type/index.md +++ b/docs/native-code/rtp-hdrext/video-content-type/README.md @@ -1,3 +1,5 @@ +# Video Content Type + The Video Content Type extension is used to communicate a video content type from sender to receiver of rtp video stream. Contact for more info. diff --git a/docs/native-code/rtp-hdrext/video-timing/index.md b/docs/native-code/rtp-hdrext/video-timing/README.md similarity index 96% rename from docs/native-code/rtp-hdrext/video-timing/index.md rename to docs/native-code/rtp-hdrext/video-timing/README.md index 965de2f89a..6f862f6157 100644 --- a/docs/native-code/rtp-hdrext/video-timing/index.md +++ b/docs/native-code/rtp-hdrext/video-timing/README.md @@ -1,3 +1,5 @@ +# Video Timing + The Video Timing extension is used to communicate a timing information on per-frame basis to receiver of rtp video stream. Contact for more info. It may be generalized to audio frames as well in the future. @@ -37,4 +39,4 @@ reserved timstamps, are not set by the sender but are reserved in packet for any in-network RTP stream processor to modify. Notes: Extension shoud be present only in the last packet of video frames. If -attached to other packets it should be ignored. \ No newline at end of file +attached to other packets it should be ignored.