Skip to content

Commit 1ea9ce1

Browse files
DarksonnDarksonn
authored
ci: fix cfg!(miri) declarations in tests (#7286)
1 parent 4d4d126 commit 1ea9ce1

File tree

8 files changed

+28
-30
lines changed

8 files changed

+28
-30
lines changed

‎tokio/src/net/tcp/listener.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -84,13 +84,12 @@ impl TcpListener {
8484
/// # Examples
8585
///
8686
/// ```no_run
87-
/// # if cfg!(miri) { return } // No `socket` in miri.
8887
/// use tokio::net::TcpListener;
89-
///
9088
/// use std::io;
9189
///
9290
/// #[tokio::main]
9391
/// async fn main() -> io::Result<()> {
92+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
9493
/// let listener = TcpListener::bind("127.0.0.1:2345").await?;
9594
///
9695
/// // use the listener

‎tokio/src/net/tcp/socket.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -743,12 +743,12 @@ impl TcpSocket {
743743
/// # Examples
744744
///
745745
/// ```
746-
/// # if cfg!(miri) { return } // No `socket` in miri.
747746
/// use tokio::net::TcpSocket;
748747
/// use socket2::{Domain, Socket, Type};
749748
///
750749
/// #[tokio::main]
751750
/// async fn main() -> std::io::Result<()> {
751+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
752752
/// let socket2_socket = Socket::new(Domain::IPV4, Type::STREAM, None)?;
753753
/// socket2_socket.set_nonblocking(true)?;
754754
///

‎tokio/src/net/tcp/stream.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -220,7 +220,6 @@ impl TcpStream {
220220
/// # Examples
221221
///
222222
/// ```
223-
/// # if cfg!(miri) { return } // No `socket` in miri.
224223
/// use std::error::Error;
225224
/// use std::io::Read;
226225
/// use tokio::net::TcpListener;
@@ -229,6 +228,7 @@ impl TcpStream {
229228
///
230229
/// #[tokio::main]
231230
/// async fn main() -> Result<(), Box<dyn Error>> {
231+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
232232
/// let mut data = [0u8; 12];
233233
/// # if false {
234234
/// let listener = TcpListener::bind("127.0.0.1:34254").await?;

‎tokio/src/net/udp.rs

+3-3
Original file line numberDiff line numberDiff line change
@@ -135,12 +135,12 @@ impl UdpSocket {
135135
/// # Example
136136
///
137137
/// ```no_run
138-
/// # if cfg!(miri) { return } // No `socket` in miri.
139138
/// use tokio::net::UdpSocket;
140139
/// use std::io;
141140
///
142141
/// #[tokio::main]
143142
/// async fn main() -> io::Result<()> {
143+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
144144
/// let sock = UdpSocket::bind("0.0.0.0:8080").await?;
145145
/// // use `sock`
146146
/// # let _ = sock;
@@ -303,12 +303,12 @@ impl UdpSocket {
303303
/// # Example
304304
///
305305
/// ```
306-
/// # if cfg!(miri) { return } // No `socket` in miri.
307306
/// use tokio::net::UdpSocket;
308307
///
309308
/// # use std::{io, net::SocketAddr};
310309
/// # #[tokio::main]
311310
/// # async fn main() -> io::Result<()> {
311+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
312312
/// let addr = "0.0.0.0:8080".parse::<SocketAddr>().unwrap();
313313
/// let peer = "127.0.0.1:11100".parse::<SocketAddr>().unwrap();
314314
/// let sock = UdpSocket::bind(addr).await?;
@@ -2130,12 +2130,12 @@ impl UdpSocket {
21302130
///
21312131
/// # Examples
21322132
/// ```
2133-
/// # if cfg!(miri) { return } // No `socket` in miri.
21342133
/// use tokio::net::UdpSocket;
21352134
/// use std::io;
21362135
///
21372136
/// #[tokio::main]
21382137
/// async fn main() -> io::Result<()> {
2138+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
21392139
/// // Create a socket
21402140
/// let socket = UdpSocket::bind("0.0.0.0:8080").await?;
21412141
///

‎tokio/src/net/unix/datagram/socket.rs

+19-19
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ cfg_net_unix! {
3636
/// # Examples
3737
/// Using named sockets, associated with a filesystem path:
3838
/// ```
39-
/// # if cfg!(miri) { return } // No `socket` in miri.
4039
/// # use std::error::Error;
4140
/// # #[tokio::main]
4241
/// # async fn main() -> Result<(), Box<dyn Error>> {
42+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
4343
/// use tokio::net::UnixDatagram;
4444
/// use tempfile::tempdir;
4545
///
@@ -69,10 +69,10 @@ cfg_net_unix! {
6969
///
7070
/// Using unnamed sockets, created as a pair
7171
/// ```
72-
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
7372
/// # use std::error::Error;
7473
/// # #[tokio::main]
7574
/// # async fn main() -> Result<(), Box<dyn Error>> {
75+
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
7676
/// use tokio::net::UnixDatagram;
7777
///
7878
/// // Create the pair of sockets
@@ -374,10 +374,10 @@ impl UnixDatagram {
374374
///
375375
/// # Examples
376376
/// ```
377-
/// # if cfg!(miri) { return } // No `socket` in miri.
378377
/// # use std::error::Error;
379378
/// # #[tokio::main]
380379
/// # async fn main() -> Result<(), Box<dyn Error>> {
380+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
381381
/// use tokio::net::UnixDatagram;
382382
/// use tempfile::tempdir;
383383
///
@@ -407,10 +407,10 @@ impl UnixDatagram {
407407
///
408408
/// # Examples
409409
/// ```
410-
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
411410
/// # use std::error::Error;
412411
/// # #[tokio::main]
413412
/// # async fn main() -> Result<(), Box<dyn Error>> {
413+
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
414414
/// use tokio::net::UnixDatagram;
415415
///
416416
/// // Create the pair of sockets
@@ -466,10 +466,10 @@ impl UnixDatagram {
466466
/// explicitly with [`Runtime::enter`](crate::runtime::Runtime::enter) function.
467467
/// # Examples
468468
/// ```
469-
/// # if cfg!(miri) { return } // No `socket` in miri.
470469
/// # use std::error::Error;
471470
/// # #[tokio::main]
472471
/// # async fn main() -> Result<(), Box<dyn Error>> {
472+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
473473
/// use tokio::net::UnixDatagram;
474474
/// use std::os::unix::net::UnixDatagram as StdUDS;
475475
/// use tempfile::tempdir;
@@ -533,10 +533,10 @@ impl UnixDatagram {
533533
///
534534
/// # Examples
535535
/// ```
536-
/// # if cfg!(miri) { return } // No `socket` in miri.
537536
/// # use std::error::Error;
538537
/// # #[tokio::main]
539538
/// # async fn main() -> Result<(), Box<dyn Error>> {
539+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
540540
/// use tokio::net::UnixDatagram;
541541
/// use tempfile::tempdir;
542542
///
@@ -573,10 +573,10 @@ impl UnixDatagram {
573573
///
574574
/// # Examples
575575
/// ```
576-
/// # if cfg!(miri) { return } // No `socket` in miri.
577576
/// # use std::error::Error;
578577
/// # #[tokio::main]
579578
/// # async fn main() -> Result<(), Box<dyn Error>> {
579+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
580580
/// use tokio::net::UnixDatagram;
581581
/// use tempfile::tempdir;
582582
///
@@ -618,10 +618,10 @@ impl UnixDatagram {
618618
///
619619
/// # Examples
620620
/// ```
621-
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
622621
/// # use std::error::Error;
623622
/// # #[tokio::main]
624623
/// # async fn main() -> Result<(), Box<dyn Error>> {
624+
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
625625
/// use tokio::net::UnixDatagram;
626626
///
627627
/// // Create the pair of sockets
@@ -749,10 +749,10 @@ impl UnixDatagram {
749749
///
750750
/// # Examples
751751
/// ```
752-
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
753752
/// # use std::error::Error;
754753
/// # #[tokio::main]
755754
/// # async fn main() -> Result<(), Box<dyn Error>> {
755+
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
756756
/// use tokio::net::UnixDatagram;
757757
///
758758
/// // Create the pair of sockets
@@ -900,10 +900,10 @@ impl UnixDatagram {
900900
///
901901
/// # Examples
902902
/// ```
903-
/// # if cfg!(miri) { return } // No `socket` in miri.
904903
/// # use std::error::Error;
905904
/// # #[tokio::main]
906905
/// # async fn main() -> Result<(), Box<dyn Error>> {
906+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
907907
/// use tokio::net::UnixDatagram;
908908
/// use tempfile::tempdir;
909909
///
@@ -1017,10 +1017,10 @@ impl UnixDatagram {
10171017
///
10181018
/// # Examples
10191019
/// ```
1020-
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
10211020
/// # use std::error::Error;
10221021
/// # #[tokio::main]
10231022
/// # async fn main() -> Result<(), Box<dyn Error>> {
1023+
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
10241024
/// use tokio::net::UnixDatagram;
10251025
///
10261026
/// // Create the pair of sockets
@@ -1068,10 +1068,10 @@ impl UnixDatagram {
10681068
///
10691069
/// # Examples
10701070
/// ```
1071-
/// # if cfg!(miri) { return } // No `socket` in miri.
10721071
/// # use std::error::Error;
10731072
/// # #[tokio::main]
10741073
/// # async fn main() -> Result<(), Box<dyn Error>> {
1074+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
10751075
/// use tokio::net::UnixDatagram;
10761076
/// use tempfile::tempdir;
10771077
///
@@ -1119,10 +1119,10 @@ impl UnixDatagram {
11191119
///
11201120
/// # Examples
11211121
/// ```
1122-
/// # if cfg!(miri) { return } // No `socket` in miri.
11231122
/// # use std::error::Error;
11241123
/// # #[tokio::main]
11251124
/// # async fn main() -> Result<(), Box<dyn Error>> {
1125+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
11261126
/// use tokio::net::UnixDatagram;
11271127
/// use tempfile::tempdir;
11281128
///
@@ -1436,10 +1436,10 @@ impl UnixDatagram {
14361436
/// # Examples
14371437
/// For a socket bound to a local path
14381438
/// ```
1439-
/// # if cfg!(miri) { return } // No `socket` in miri.
14401439
/// # use std::error::Error;
14411440
/// # #[tokio::main]
14421441
/// # async fn main() -> Result<(), Box<dyn Error>> {
1442+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
14431443
/// use tokio::net::UnixDatagram;
14441444
/// use tempfile::tempdir;
14451445
///
@@ -1459,10 +1459,10 @@ impl UnixDatagram {
14591459
///
14601460
/// For an unbound socket
14611461
/// ```
1462-
/// # if cfg!(miri) { return } // No `socket` in miri.
14631462
/// # use std::error::Error;
14641463
/// # #[tokio::main]
14651464
/// # async fn main() -> Result<(), Box<dyn Error>> {
1465+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
14661466
/// use tokio::net::UnixDatagram;
14671467
///
14681468
/// // Create an unbound socket
@@ -1484,10 +1484,10 @@ impl UnixDatagram {
14841484
/// # Examples
14851485
/// For a peer with a local path
14861486
/// ```
1487-
/// # if cfg!(miri) { return } // No `socket` in miri.
14881487
/// # use std::error::Error;
14891488
/// # #[tokio::main]
14901489
/// # async fn main() -> Result<(), Box<dyn Error>> {
1490+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
14911491
/// use tokio::net::UnixDatagram;
14921492
/// use tempfile::tempdir;
14931493
///
@@ -1510,10 +1510,10 @@ impl UnixDatagram {
15101510
///
15111511
/// For an unbound peer
15121512
/// ```
1513-
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
15141513
/// # use std::error::Error;
15151514
/// # #[tokio::main]
15161515
/// # async fn main() -> Result<(), Box<dyn Error>> {
1516+
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
15171517
/// use tokio::net::UnixDatagram;
15181518
///
15191519
/// // Create the pair of sockets
@@ -1532,10 +1532,10 @@ impl UnixDatagram {
15321532
///
15331533
/// # Examples
15341534
/// ```
1535-
/// # if cfg!(miri) { return } // No `socket` in miri.
15361535
/// # use std::error::Error;
15371536
/// # #[tokio::main]
15381537
/// # async fn main() -> Result<(), Box<dyn Error>> {
1538+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
15391539
/// use tokio::net::UnixDatagram;
15401540
///
15411541
/// // Create an unbound socket
@@ -1560,10 +1560,10 @@ impl UnixDatagram {
15601560
///
15611561
/// # Examples
15621562
/// ```
1563-
/// # if cfg!(miri) { return } // No SOCK_DGRAM for `socketpair` in miri.
15641563
/// # use std::error::Error;
15651564
/// # #[tokio::main]
15661565
/// # async fn main() -> Result<(), Box<dyn Error>> {
1566+
/// # if cfg!(miri) { return Ok(()); } // No SOCK_DGRAM for `socketpair` in miri.
15671567
/// use tokio::net::UnixDatagram;
15681568
/// use std::net::Shutdown;
15691569
///

‎tokio/src/net/unix/stream.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -840,7 +840,6 @@ impl UnixStream {
840840
/// # Examples
841841
///
842842
/// ```
843-
/// # if cfg!(miri) { return } // No `socket` in miri.
844843
/// use std::error::Error;
845844
/// use std::io::Read;
846845
/// use tokio::net::UnixListener;
@@ -849,6 +848,7 @@ impl UnixStream {
849848
///
850849
/// #[tokio::main]
851850
/// async fn main() -> Result<(), Box<dyn Error>> {
851+
/// # if cfg!(miri) { return Ok(()); } // No `socket` in miri.
852852
/// let dir = tempfile::tempdir().unwrap();
853853
/// let bind_path = dir.path().join("bind_path");
854854
///

‎tokio/src/process/mod.rs

+1-2
Original file line numberDiff line numberDiff line change
@@ -810,7 +810,6 @@ impl Command {
810810
/// Basic usage:
811811
///
812812
/// ```no_run
813-
/// # if cfg!(miri) { return } // No `pidfd_spawnp` in miri.
814813
/// use tokio::process::Command;
815814
///
816815
/// async fn run_ls() -> std::process::ExitStatus {
@@ -1347,7 +1346,6 @@ impl Child {
13471346
/// This function is cancel safe.
13481347
///
13491348
/// ```
1350-
/// # if cfg!(miri) { return } // No `pidfd_spawnp` in miri.
13511349
/// # #[cfg(not(unix))]fn main(){}
13521350
/// # #[cfg(unix)]
13531351
/// use tokio::io::AsyncWriteExt;
@@ -1359,6 +1357,7 @@ impl Child {
13591357
/// # #[cfg(unix)]
13601358
/// #[tokio::main]
13611359
/// async fn main() {
1360+
/// # if cfg!(miri) { return; } // No `pidfd_spawnp` in miri.
13621361
/// let mut child = Command::new("cat")
13631362
/// .stdin(Stdio::piped())
13641363
/// .spawn()

‎tokio/src/runtime/runtime.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -407,14 +407,14 @@ impl Runtime {
407407
/// # Examples
408408
///
409409
/// ```
410-
/// # if cfg!(miri) { return } // Miri reports error when main thread terminated without waiting all remaining threads.
411410
/// use tokio::runtime::Runtime;
412411
/// use tokio::task;
413412
///
414413
/// use std::thread;
415414
/// use std::time::Duration;
416415
///
417416
/// fn main() {
417+
/// # if cfg!(miri) { return } // Miri reports error when main thread terminated without waiting all remaining threads.
418418
/// let runtime = Runtime::new().unwrap();
419419
///
420420
/// runtime.block_on(async move {

0 commit comments

Comments
 (0)