fix: hyperlinks in doc and ignore test dependent on speed of execution (

#476) * format links properly in docs * ignore test that is sensitive to execution environment Co-authored-by: henil <henil@gmail.com> Co-authored-by: Devdutt Shenoi <devdutt@outlook.in>
bytebeamio · Oct 29, 2022 · 197412e · 197412e
1 parent 6e1d947
commit 197412e
Show file tree

Hide file tree

Showing 13 changed files with 13 additions and 12 deletions.
diff --git a/benchmarks/simplerouter/src/protocol/mod.rs b/benchmarks/simplerouter/src/protocol/mod.rs
@@ -144,7 +144,7 @@ pub fn qos(num: u8) -> Result<QoS, Error> {
 ///          |         Remaining Bytes Len  (1/2/3/4 bytes)        |
 ///          +-----------------------------------------------------+
 ///
-/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
+/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
 /// ```
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
 pub struct FixedHeader {

diff --git a/rumqttc/src/mqttbytes/mod.rs b/rumqttc/src/mqttbytes/mod.rs
@@ -108,7 +108,7 @@ pub enum QoS {
 ///          |         Remaining Bytes Len  (1/2/3/4 bytes)        |
 ///          +-----------------------------------------------------+
 ///
-/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
+/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
 /// ```
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
 pub struct FixedHeader {

diff --git a/rumqttc/src/v5/mqttbytes/v5/mod.rs b/rumqttc/src/v5/mqttbytes/v5/mod.rs
@@ -205,7 +205,7 @@ enum PropertyType {
 ///          |         Remaining Bytes Len  (1/2/3/4 bytes)        |
 ///          +-----------------------------------------------------+
 ///
-/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
+/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
 /// ```
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
 pub struct FixedHeader {

diff --git a/rumqttc/src/v5/mqttbytes/v5/pubcomp.rs b/rumqttc/src/v5/mqttbytes/v5/pubcomp.rs
@@ -6,7 +6,7 @@ fn len(pubcomp: &PubComp, properties: &Option<PubCompProperties>) -> usize {
 
     // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
     // and there are no Properties. In this case the PUBCOMP has a Remaining Length of 2.
-    // ref: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154
+    // <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154>
     if pubcomp.reason == PubCompReason::Success && properties.is_none() {
         return 2;
     }

diff --git a/rumqttc/src/v5/mqttbytes/v5/pubrec.rs b/rumqttc/src/v5/mqttbytes/v5/pubrec.rs
@@ -6,7 +6,7 @@ fn len(pubrec: &PubRec, properties: &Option<PubRecProperties>) -> usize {
 
     // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
     // and there are no Properties. In this case the PUBREC has a Remaining Length of 2.
-    // As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134
+    // <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134>
     if pubrec.reason == PubRecReason::Success && properties.is_none() {
         return 2;
     }

diff --git a/rumqttc/src/v5/mqttbytes/v5/pubrel.rs b/rumqttc/src/v5/mqttbytes/v5/pubrel.rs
@@ -6,7 +6,7 @@ fn len(pubrel: &PubRel, properties: &Option<PubRelProperties>) -> usize {
 
     // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
     // and there are no Properties. In this case the PUBREL has a Remaining Length of 2.
-    // As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144
+    // <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144>
     if pubrel.reason == PubRelReason::Success && properties.is_none() {
         return 2;
     }

diff --git a/rumqttc/tests/reliability.rs b/rumqttc/tests/reliability.rs
@@ -291,6 +291,7 @@ async fn requests_are_recovered_after_inflight_queue_size_falls_below_max() {
     assert!(broker.read_publish().await.is_none());
 }
 
+#[ignore]
 #[tokio::test]
 async fn packet_id_collisions_are_detected_and_flow_control_is_applied() {
     let mut options = MqttOptions::new("dummy", "127.0.0.1", 1891);

diff --git a/rumqttd-old/src/mqttbytes/mod.rs b/rumqttd-old/src/mqttbytes/mod.rs
@@ -107,7 +107,7 @@ pub enum QoS {
 ///          |         Remaining Bytes Len  (1/2/3/4 bytes)        |
 ///          +-----------------------------------------------------+
 ///
-/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
+/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
 /// ```
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
 pub struct FixedHeader {

diff --git a/rumqttd/src/protocol/v4/mod.rs b/rumqttd/src/protocol/v4/mod.rs
@@ -52,7 +52,7 @@ pub enum PacketType {
 ///          |         Remaining Bytes Len  (1/2/3/4 bytes)        |
 ///          +-----------------------------------------------------+
 ///
-/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
+/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
 /// ```
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
 pub struct FixedHeader {

diff --git a/rumqttd/src/protocol/v5/mod.rs b/rumqttd/src/protocol/v5/mod.rs
@@ -81,7 +81,7 @@ enum PropertyType {
 ///          |         Remaining Bytes Len  (1/2/3/4 bytes)        |
 ///          +-----------------------------------------------------+
 ///
-/// http://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Figure_2.2_-
+/// <https://docs.oasis-open.org/mqtt/mqtt/v3.1.1/os/mqtt-v3.1.1-os.html#_Toc385349207>
 /// ```
 #[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd)]
 pub struct FixedHeader {

diff --git a/rumqttd/src/protocol/v5/pubcomp.rs b/rumqttd/src/protocol/v5/pubcomp.rs
@@ -6,7 +6,7 @@ fn len(pubcomp: &PubComp, properties: &Option<PubCompProperties>) -> usize {
 
     // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
     // and there are no Properties. In this case the PUBCOMP has a Remaining Length of 2.
-    // ref: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154
+    // <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901154>
     if pubcomp.reason == PubCompReason::Success && properties.is_none() {
         return 2;
     }

diff --git a/rumqttd/src/protocol/v5/pubrec.rs b/rumqttd/src/protocol/v5/pubrec.rs
@@ -6,7 +6,7 @@ fn len(pubrec: &PubRec, properties: &Option<PubRecProperties>) -> usize {
 
     // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
     // and there are no Properties. In this case the PUBREC has a Remaining Length of 2.
-    // As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134
+    // <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901134>
     if pubrec.reason == PubRecReason::Success && properties.is_none() {
         return 2;
     }

diff --git a/rumqttd/src/protocol/v5/pubrel.rs b/rumqttd/src/protocol/v5/pubrel.rs
@@ -6,7 +6,7 @@ fn len(pubrel: &PubRel, properties: &Option<PubRelProperties>) -> usize {
 
     // The Reason Code and Property Length can be omitted if the Reason Code is 0x00 (Success)
     // and there are no Properties. In this case the PUBREL has a Remaining Length of 2.
-    // As mentioned in: https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144
+    // <https://docs.oasis-open.org/mqtt/mqtt/v5.0/os/mqtt-v5.0-os.html#_Toc3901144>
     if pubrel.reason == PubRelReason::Success && properties.is_none() {
         return 2;
     }