standardized all RFC links

kenaniah · kenaniah · commit 3d80b5e1da9f · 2023-09-10T13:39:27.000-07:00
diff --git a/ice/src/tcp_type/mod.rs b/ice/src/tcp_type/mod.rs
@@ -4,7 +4,7 @@ mod tcp_type_test;
 use std::fmt;
 
 // TCPType is the type of ICE TCP candidate as described in
-// ttps://tools.ietf.org/html/rfc6544#section-4.5
+// https://tools.ietf.org/html/rfc6544#section-4.5
 #[derive(PartialEq, Eq, Debug, Copy, Clone)]
 pub enum TcpType {
     /// The default value. For example UDP candidates do not need this field.
diff --git a/ice/src/udp_mux/mod.rs b/ice/src/udp_mux/mod.rs
@@ -137,7 +137,7 @@ impl UDPMuxDefault {
 
                 let s = match String::from_utf8(attr.value) {
                     // Per the RFC this shouldn't happen
-                    // https://datatracker.ietf.org/doc/html/rfc5389#section-15.3
+                    // https://tools.ietf.org/html/rfc5389#section-15.3
                     Err(err) => {
                         log::warn!(
                             "Failed to decode USERNAME from STUN message as UTF-8: {}",
diff --git a/interceptor/src/stats/interceptor.rs b/interceptor/src/stats/interceptor.rs
@@ -787,7 +787,7 @@ impl RTPWriter for RTPWriteRecorder {
 }
 
 /// Calculate the round trip time for a given peer as described in
-/// [RFC3550 6.4.1](https://datatracker.ietf.org/doc/html/rfc3550#section-6.4.1).
+/// [RFC3550 6.4.1](https://tools.ietf.org/html/rfc3550#section-6.4.1).
 ///
 /// ## Params
 ///
diff --git a/interceptor/src/stats/mod.rs b/interceptor/src/stats/mod.rs
@@ -362,7 +362,7 @@ mod outbound {
         remote_round_trip_time_measurements: u64,
 
         /// The fraction of packets lost reported for this stream.
-        /// Calculated as defined in [RFC3550](https://www.rfc-editor.org/rfc/rfc3550) section 6.4.1 and Appendix A.3.
+        /// Calculated as defined in [RFC3550](https://tools.ietf.org/html/rfc3550) section 6.4.1 and Appendix A.3.
         remote_fraction_lost: Option<f64>,
     }
 
diff --git a/interceptor/src/twcc/mod.rs b/interceptor/src/twcc/mod.rs
@@ -19,7 +19,7 @@ struct PktInfo {
 
 /// Recorder records incoming RTP packets and their delays and creates
 /// transport wide congestion control feedback reports as specified in
-/// https://datatracker.ietf.org/doc/html/draft-holmer-rmcat-transport-wide-cc-extensions-01
+/// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01
 #[derive(Default, Debug, PartialEq, Clone)]
 pub struct Recorder {
     received_packets: Vec<PktInfo>,
diff --git a/interceptor/src/twcc/receiver/mod.rs b/interceptor/src/twcc/receiver/mod.rs
@@ -69,7 +69,7 @@ struct ReceiverInternal {
 }
 
 /// Receiver sends transport wide congestion control reports as specified in:
-/// https://datatracker.ietf.org/doc/html/draft-holmer-rmcat-transport-wide-cc-extensions-01
+/// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01
 pub struct Receiver {
     internal: Arc<ReceiverInternal>,
 
diff --git a/rtp/src/codecs/h265/mod.rs b/rtp/src/codecs/h265/mod.rs
@@ -11,15 +11,15 @@ mod h265_test;
 ///
 
 const H265NALU_HEADER_SIZE: usize = 2;
-/// https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.2
+/// https://tools.ietf.org/html/rfc7798#section-4.4.2
 const H265NALU_AGGREGATION_PACKET_TYPE: u8 = 48;
-/// https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.3
+/// https://tools.ietf.org/html/rfc7798#section-4.4.3
 const H265NALU_FRAGMENTATION_UNIT_TYPE: u8 = 49;
-/// https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.4
+/// https://tools.ietf.org/html/rfc7798#section-4.4.4
 const H265NALU_PACI_PACKET_TYPE: u8 = 50;
 
 /// H265NALUHeader is a H265 NAL Unit Header
-/// https://datatracker.ietf.org/doc/html/rfc7798#section-1.1.4
+/// https://tools.ietf.org/html/rfc7798#section-1.1.4
 /// +---------------+---------------+
 ///  |0|1|2|3|4|5|6|7|0|1|2|3|4|5|6|7|
 ///  +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
@@ -97,7 +97,7 @@ impl H265NALUHeader {
 ///   |                               :...OPTIONAL RTP padding        |
 ///   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 ///
-/// Reference: https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.1
+/// Reference: https://tools.ietf.org/html/rfc7798#section-4.4.1
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct H265SingleNALUnitPacket {
     /// payload_header is the header of the H265 packet.
@@ -186,7 +186,7 @@ impl H265SingleNALUnitPacket {
 ///   |                               :
 ///   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 ///
-/// Reference: https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.2
+/// Reference: https://tools.ietf.org/html/rfc7798#section-4.4.2
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct H265AggregationUnitFirst {
     donl: Option<u16>,
@@ -226,7 +226,7 @@ impl H265AggregationUnitFirst {
 ///   |                               :
 ///   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 ///
-/// Reference: https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.2
+/// Reference: https://tools.ietf.org/html/rfc7798#section-4.4.2
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct H265AggregationUnit {
     dond: Option<u8>,
@@ -266,7 +266,7 @@ impl H265AggregationUnit {
 ///   |                               :...OPTIONAL RTP padding        |
 ///   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 ///
-/// Reference: https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.2
+/// Reference: https://tools.ietf.org/html/rfc7798#section-4.4.2
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct H265AggregationPacket {
     first_unit: Option<H265AggregationUnitFirst>,
@@ -427,7 +427,7 @@ impl H265FragmentationUnitHeader {
 /// |                               :...OPTIONAL RTP padding        |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 ///
-/// Reference: https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.3
+/// Reference: https://tools.ietf.org/html/rfc7798#section-4.4.3
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct H265FragmentationUnitPacket {
     /// payload_header is the header of the H265 packet.
@@ -526,7 +526,7 @@ impl H265FragmentationUnitPacket {
 /// |                               :...OPTIONAL RTP padding        |
 /// +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
 ///
-/// Reference: https://datatracker.ietf.org/doc/html/rfc7798#section-4.4.4
+/// Reference: https://tools.ietf.org/html/rfc7798#section-4.4.4
 #[derive(Default, Debug, Clone, PartialEq, Eq)]
 pub struct H265PACIPacket {
     /// payload_header is the header of the H265 packet.
@@ -655,7 +655,7 @@ impl H265PACIPacket {
 ///
 
 /// H265TSCI is a Temporal Scalability Control Information header extension.
-/// Reference: https://datatracker.ietf.org/doc/html/rfc7798#section-4.5
+/// Reference: https://tools.ietf.org/html/rfc7798#section-4.5
 #[derive(Default, Debug, Copy, Clone, PartialEq, Eq)]
 pub struct H265TSCI(pub u32);
 
diff --git a/sctp/src/association/association_internal.rs b/sctp/src/association/association_internal.rs
@@ -665,7 +665,7 @@ impl AssociationInternal {
             ..Default::default()
         };
 
-        // According to RFC https://datatracker.ietf.org/doc/html/rfc4960#section-3.2.2
+        // According to RFC https://tools.ietf.org/html/rfc4960#section-3.2.2
         // We report unknown parameters with a paramtype with bit 14 set as unrecognized
         let unrecognized_params_from_init = i
             .params
@@ -2174,7 +2174,7 @@ impl AssociationInternal {
             self.handle_shutdown_complete(c).await?
         } else {
             /*
-            https://datatracker.ietf.org/doc/html/rfc4960#section-3
+            https://tools.ietf.org/html/rfc4960#section-3
 
             00 -  Stop processing this SCTP packet and discard it, do not
                   process any further chunks within it.
diff --git a/sctp/src/param/mod.rs b/sctp/src/param/mod.rs
@@ -75,7 +75,7 @@ pub(crate) fn build_param(raw_param: &Bytes) -> Result<Box<dyn Param + Send + Sy
         ParamType::OutSsnResetReq => Ok(Box::new(ParamOutgoingResetRequest::unmarshal(raw_param)?)),
         ParamType::ReconfigResp => Ok(Box::new(ParamReconfigResponse::unmarshal(raw_param)?)),
         _ => {
-            // According to RFC https://datatracker.ietf.org/doc/html/rfc4960#section-3.2.1
+            // According to RFC https://tools.ietf.org/html/rfc4960#section-3.2.1
             let stop_processing = ((raw_type >> 15) & 0x01) == 0;
             if stop_processing {
                 Err(Error::ErrParamTypeUnhandled { typ: raw_type })
diff --git a/webrtc/src/ice_transport/ice_server.rs b/webrtc/src/ice_transport/ice_server.rs
@@ -7,14 +7,14 @@ use crate::ice_transport::ice_credential_type::RTCIceCredentialType;
 /// the ICE Agent to establish a connection with a peer.
 #[derive(Default, Debug, Clone, Serialize, Deserialize, Hash)]
 pub struct RTCIceServer {
-    /// A sequence of [STUN](https://www.rfc-editor.org/rfc/rfc5389)
-    /// or [TURN](https://www.rfc-editor.org/rfc/rfc5928) URIs to be used by
+    /// A sequence of [STUN](https://tools.ietf.org/html/rfc5389)
+    /// or [TURN](https://tools.ietf.org/html/rfc5928) URIs to be used by
     /// the ICE Agent to establish a connection with a peer.
     ///
-    /// STUN URIs (defined in [RFC7064](https://www.rfc-editor.org/rfc/rfc7064))
+    /// STUN URIs (defined in [RFC7064](https://tools.ietf.org/html/rfc7064))
     /// allow for the discovery of server-reflexive candidates.
     ///
-    /// TURN URIs (defined in [RFC7065](https://www.rfc-editor.org/rfc/rfc7065))
+    /// TURN URIs (defined in [RFC7065](https://tools.ietf.org/html/rfc7065))
     /// allow for the discovery of relayed candidates.
     pub urls: Vec<String>,
 
@@ -26,7 +26,7 @@ pub struct RTCIceServer {
     /// If this [`RTCIceServer`] object represents a TURN server, then this attribute
     /// specifies the credential to use during the authentication process with the
     /// TURN server. It represents a long-term authentication password, as described
-    /// in [RFC5389](https://www.rfc-editor.org/rfc/rfc5389).
+    /// in [RFC5389](https://tools.ietf.org/html/rfc5389).
     pub credential: String,
 
     /// **NOT IN SPEC:** If this [`RTCIceServer`] object represents a TURN server,
diff --git a/webrtc/src/peer_connection/configuration.rs b/webrtc/src/peer_connection/configuration.rs
@@ -55,7 +55,7 @@ pub struct RTCConfiguration {
     pub certificates: Vec<RTCCertificate>,
 
     /// **UNIMPLEMENTED:** The size of the prefetched ICE pool, as defined in
-    /// [RFC8829](https://www.rfc-editor.org/rfc/rfc8829).
+    /// [RFC8829](https://tools.ietf.org/html/rfc8829).
     pub ice_candidate_pool_size: u8,
 }
 
diff --git a/webrtc/src/peer_connection/policy/bundle_policy.rs b/webrtc/src/peer_connection/policy/bundle_policy.rs
@@ -2,29 +2,30 @@ use std::fmt;
 
 use serde::{Deserialize, Serialize};
 
-/// BundlePolicy affects which media tracks are negotiated if the remote
+/// The bundle policy affects which media tracks are negotiated if the remote
 /// endpoint is not bundle-aware, and what ICE candidates are gathered. If the
 /// remote endpoint is bundle-aware, all media tracks and data channels are
-/// bundled onto the same transport.
+/// bundled onto the same transport. This is described in
+/// [RFC8829](https://tools.ietf.org/html/rfc8829).
 #[derive(Default, Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize)]
 pub enum RTCBundlePolicy {
     #[default]
     Unspecified = 0,
 
-    /// BundlePolicyBalanced indicates to gather ICE candidates for each
+    /// Gather ICE candidates for each
     /// media type in use (audio, video, and data). If the remote endpoint is
     /// not bundle-aware, negotiate only one audio and video track on separate
     /// transports.
     #[serde(rename = "balanced")]
     Balanced = 1,
 
-    /// BundlePolicyMaxCompat indicates to gather ICE candidates for each
+    /// Gather ICE candidates for each
     /// track. If the remote endpoint is not bundle-aware, negotiate all media
     /// tracks on separate transports.
     #[serde(rename = "max-compat")]
     MaxCompat = 2,
 
-    /// BundlePolicyMaxBundle indicates to gather ICE candidates for only
+    /// Gather ICE candidates for only
     /// one track. If the remote endpoint is not bundle-aware, negotiate only
     /// one media track.
     #[serde(rename = "max-bundle")]
diff --git a/webrtc/src/peer_connection/policy/ice_transport_policy.rs b/webrtc/src/peer_connection/policy/ice_transport_policy.rs
@@ -2,8 +2,10 @@ use std::fmt;
 
 use serde::{Deserialize, Serialize};
 
-/// Defines the policy that will be used to determine the
-/// permitted ICE candidates that will be used for connectivity checks.
+/// Defines the ICE candidate policy
+/// ([RFC8829](https://datatracker.ietf.org/doc/html/rfc8829#section-4.1.1))
+/// that will be used to determine the permitted ICE candidates. Permitted
+/// candidates will be used for connectivity checks.
 #[derive(Default, Debug, PartialEq, Eq, Copy, Clone, Serialize, Deserialize)]
 pub enum RTCIceTransportPolicy {
     #[default]
diff --git a/webrtc/src/peer_connection/sdp/mod.rs b/webrtc/src/peer_connection/sdp/mod.rs
@@ -487,7 +487,7 @@ pub(crate) async fn add_transceiver_sdp(
             // We need to include connection information even if we're rejecting a track, otherwise Firefox will fail to
             // parse the SDP with an error like:
             // SIPCC Failed to parse SDP: SDP Parse Error on line 50:  c= connection line not specified for every media level, validation failed.
-            // In addition this makes our SDP compliant with RFC 4566 Section 5.7: https://datatracker.ietf.org/doc/html/rfc4566#section-5.7
+            // In addition this makes our SDP compliant with RFC 4566 Section 5.7: https://tools.ietf.org/html/rfc4566#section-5.7
             connection_information: Some(ConnectionInformation {
                 network_type: "IN".to_owned(),
                 address_type: "IP4".to_owned(),
@@ -557,7 +557,7 @@ pub(crate) async fn add_transceiver_sdp(
             // After we have include an msid attribute in an offer it must stay the same for
             // all subsequent offer even if the track or transceiver direction changes.
             //
-            // [RFC 8829 Section 5.2.2](https://datatracker.ietf.org/doc/html/rfc8829#section-5.2.2)
+            // [RFC 8829 Section 5.2.2](https://tools.ietf.org/html/rfc8829#section-5.2.2)
             //
             // For RtpTransceivers that are not stopped, the "a=msid" line or
             // lines MUST stay the same if they are present in the current
@@ -604,7 +604,7 @@ pub(crate) async fn add_transceiver_sdp(
             // If don't have an offered direction to intersect with just use the transceivers
             // current direction.
             //
-            // https://datatracker.ietf.org/doc/html/rfc8829#section-4.2.3
+            // https://tools.ietf.org/html/rfc8829#section-4.2.3
             //
             //    When creating offers, the transceiver direction is directly reflected
             //    in the output, even for re-offers.

Original file line number	Diff line number	Diff line change
`@@ -787,7 +787,7 @@ impl RTPWriter for RTPWriteRecorder {`
`787`	`787`	`}`
`788`	`788`
`789`	`789`	`/// Calculate the round trip time for a given peer as described in`
`790`		`-/// [RFC3550 6.4.1](https://datatracker.ietf.org/doc/html/rfc3550#section-6.4.1).`
	`790`	`+/// [RFC3550 6.4.1](https://tools.ietf.org/html/rfc3550#section-6.4.1).`
`791`	`791`	`///`
`792`	`792`	`/// ## Params`
`793`	`793`	`///`
Original file line number	Diff line number	Diff line change
`@@ -362,7 +362,7 @@ mod outbound {`
`362`	`362`	`remote_round_trip_time_measurements: u64,`
`363`	`363`
`364`	`364`	`/// The fraction of packets lost reported for this stream.`
`365`		`- /// Calculated as defined in [RFC3550](https://www.rfc-editor.org/rfc/rfc3550) section 6.4.1 and Appendix A.3.`
	`365`	`+ /// Calculated as defined in [RFC3550](https://tools.ietf.org/html/rfc3550) section 6.4.1 and Appendix A.3.`
`366`	`366`	`remote_fraction_lost: Option<f64>,`
`367`	`367`	`}`
`368`	`368`
Original file line number	Diff line number	Diff line change
`@@ -69,7 +69,7 @@ struct ReceiverInternal {`
`69`	`69`	`}`
`70`	`70`
`71`	`71`	`/// Receiver sends transport wide congestion control reports as specified in:`
`72`		`-/// https://datatracker.ietf.org/doc/html/draft-holmer-rmcat-transport-wide-cc-extensions-01`
	`72`	`+/// https://tools.ietf.org/html/draft-holmer-rmcat-transport-wide-cc-extensions-01`
`73`	`73`	`pub struct Receiver {`
`74`	`74`	`internal: Arc<ReceiverInternal>,`
`75`	`75`