[INFO] fetching crate xsk-rs 0.4.1... [INFO] documenting xsk-rs-0.4.1 against beta-2022-05-20 for beta-1.62-rustdoc-1 [INFO] extracting crate xsk-rs 0.4.1 into /workspace/builds/worker-34/source [INFO] validating manifest of crates.io crate xsk-rs 0.4.1 on toolchain beta-2022-05-20 [INFO] running `Command { std: "/workspace/cargo-home/bin/cargo" "+beta-2022-05-20" "metadata" "--manifest-path" "Cargo.toml" "--no-deps", kill_on_drop: false }` [INFO] started tweaking crates.io crate xsk-rs 0.4.1 [INFO] finished tweaking crates.io crate xsk-rs 0.4.1 [INFO] tweaked toml for crates.io crate xsk-rs 0.4.1 written to /workspace/builds/worker-34/source/Cargo.toml [INFO] crate crates.io crate xsk-rs 0.4.1 already has a lockfile, it will not be regenerated [INFO] running `Command { std: "/workspace/cargo-home/bin/cargo" "+beta-2022-05-20" "fetch" "--manifest-path" "Cargo.toml", kill_on_drop: false }` [INFO] running `Command { std: "docker" "create" "-v" "/var/lib/crater-agent-workspace/builds/worker-34/target:/opt/rustwide/target:rw,Z" "-v" "/var/lib/crater-agent-workspace/builds/worker-34/source:/opt/rustwide/workdir:ro,Z" "-v" "/var/lib/crater-agent-workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/var/lib/crater-agent-workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "1610612736" "--user" "0:0" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/opt/rustwide/cargo-home/bin/cargo" "+beta-2022-05-20" "metadata" "--no-deps" "--format-version=1", kill_on_drop: false }` [INFO] [stdout] 780a1487b862b77e6f99153481bf02681439e53c8671d8ec1fbcc97b9ddfcdff [INFO] running `Command { std: "docker" "start" "-a" "780a1487b862b77e6f99153481bf02681439e53c8671d8ec1fbcc97b9ddfcdff", kill_on_drop: false }` [INFO] running `Command { std: "docker" "inspect" "780a1487b862b77e6f99153481bf02681439e53c8671d8ec1fbcc97b9ddfcdff", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "780a1487b862b77e6f99153481bf02681439e53c8671d8ec1fbcc97b9ddfcdff", kill_on_drop: false }` [INFO] [stdout] 780a1487b862b77e6f99153481bf02681439e53c8671d8ec1fbcc97b9ddfcdff [INFO] running `Command { std: "docker" "create" "-v" "/var/lib/crater-agent-workspace/builds/worker-34/target:/opt/rustwide/target:rw,Z" "-v" "/var/lib/crater-agent-workspace/builds/worker-34/source:/opt/rustwide/workdir:ro,Z" "-v" "/var/lib/crater-agent-workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/var/lib/crater-agent-workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "CARGO_INCREMENTAL=0" "-e" "RUST_BACKTRACE=full" "-e" "RUSTDOCFLAGS=--cap-lints=warn" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "1610612736" "--user" "0:0" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/opt/rustwide/cargo-home/bin/cargo" "+beta-2022-05-20" "doc" "--frozen" "--no-deps" "--document-private-items" "--message-format=json", kill_on_drop: false }` [INFO] [stdout] 14a5ce6a412af3cdae256c8cf0807fca2e70b86d7b78a91826e2696a67125eda [INFO] running `Command { std: "docker" "start" "-a" "14a5ce6a412af3cdae256c8cf0807fca2e70b86d7b78a91826e2696a67125eda", kill_on_drop: false }` [INFO] [stderr] Compiling cc v1.0.66 [INFO] [stderr] Compiling pkg-config v0.3.20 [INFO] [stderr] Compiling log v0.4.11 [INFO] [stderr] Compiling libc v0.2.95 [INFO] [stderr] Checking cfg-if v0.1.10 [INFO] [stderr] Checking cfg-if v1.0.0 [INFO] [stderr] Checking bitflags v1.3.2 [INFO] [stderr] Compiling libbpf-sys v0.6.0-1 [INFO] [stderr] Documenting xsk-rs v0.4.1 (/opt/rustwide/workdir) [INFO] [stderr] Finished dev [unoptimized + debuginfo] target(s) in 8.33s [INFO] running `Command { std: "docker" "inspect" "14a5ce6a412af3cdae256c8cf0807fca2e70b86d7b78a91826e2696a67125eda", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "14a5ce6a412af3cdae256c8cf0807fca2e70b86d7b78a91826e2696a67125eda", kill_on_drop: false }` [INFO] [stdout] 14a5ce6a412af3cdae256c8cf0807fca2e70b86d7b78a91826e2696a67125eda [INFO] running `Command { std: "docker" "create" "-v" "/var/lib/crater-agent-workspace/builds/worker-34/target:/opt/rustwide/target:rw,Z" "-v" "/var/lib/crater-agent-workspace/builds/worker-34/source:/opt/rustwide/workdir:ro,Z" "-v" "/var/lib/crater-agent-workspace/cargo-home:/opt/rustwide/cargo-home:ro,Z" "-v" "/var/lib/crater-agent-workspace/rustup-home:/opt/rustwide/rustup-home:ro,Z" "-e" "SOURCE_DIR=/opt/rustwide/workdir" "-e" "CARGO_TARGET_DIR=/opt/rustwide/target" "-e" "CARGO_INCREMENTAL=0" "-e" "RUST_BACKTRACE=full" "-e" "RUSTFLAGS=--cap-lints=warn" "-e" "RUSTC_BOOTSTRAP=1" "-e" "DOCS_RS=1" "-e" "CARGO_HOME=/opt/rustwide/cargo-home" "-e" "RUSTUP_HOME=/opt/rustwide/rustup-home" "-w" "/opt/rustwide/workdir" "-m" "1610612736" "--user" "0:0" "--network" "none" "ghcr.io/rust-lang/crates-build-env/linux@sha256:d190cb871061d98bc6d0581d85cb2ecb09a0f8a142ba5463de30be9999fc3251" "/opt/rustwide/cargo-home/bin/cargo" "+beta-2022-05-20" "rustdoc" "--lib" "-Zrustdoc-map" "--frozen" "--message-format=json" "--" "-Z" "unstable-options" "--document-private-items", kill_on_drop: false }` [INFO] [stdout] 52ab3aaa72cd5db37d80eab911d17e8bc942a64ab41d05e86560ca178ccd4556 [INFO] running `Command { std: "docker" "start" "-a" "52ab3aaa72cd5db37d80eab911d17e8bc942a64ab41d05e86560ca178ccd4556", kill_on_drop: false }` [INFO] [stderr] Compiling pkg-config v0.3.20 [INFO] [stderr] Compiling cc v1.0.66 [INFO] [stderr] Compiling log v0.4.11 [INFO] [stderr] Compiling libc v0.2.95 [INFO] [stderr] Checking cfg-if v0.1.10 [INFO] [stderr] Checking cfg-if v1.0.0 [INFO] [stderr] Checking bitflags v1.3.2 [INFO] [stderr] Compiling libbpf-sys v0.6.0-1 [INFO] [stderr] Documenting xsk-rs v0.4.1 (/opt/rustwide/workdir) [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Types for interacting with and creating a [`Umem`]. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] | [INFO] [stdout] note: the lint level is defined here [INFO] [stdout] --> src/lib.rs:115:9 [INFO] [stdout] | [INFO] [stdout] 115 | #![deny(rustdoc::missing_doc_code_examples)] [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! Types for representing and working with a [`Umem`](super::Umem) [INFO] [stdout] 2 | | //! frame. [INFO] [stdout] | |__________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:12:1 [INFO] [stdout] | [INFO] [stdout] 12 | / /// The length (in bytes) of data in a frame's packet data and [INFO] [stdout] 13 | | /// headroom segments. [INFO] [stdout] 14 | | /// [INFO] [stdout] 15 | | /// Not to be confused with the [`frame_headroom`] and [`mtu`], the [INFO] [stdout] ... | [INFO] [stdout] 24 | | /// [`frame_headroom`]: crate::config::UmemConfig::frame_headroom [INFO] [stdout] 25 | | /// [`mtu`]: crate::config::UmemConfig::mtu [INFO] [stdout] | |___________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:32:1 [INFO] [stdout] | [INFO] [stdout] 32 | / impl SegmentLengths { [INFO] [stdout] 33 | | /// Current length of the headroom segment. [INFO] [stdout] 34 | | #[inline] [INFO] [stdout] 35 | | pub fn headroom(&self) -> usize { [INFO] [stdout] ... | [INFO] [stdout] 43 | | } [INFO] [stdout] 44 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:33:5 [INFO] [stdout] | [INFO] [stdout] 33 | /// Current length of the headroom segment. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:39:5 [INFO] [stdout] | [INFO] [stdout] 39 | /// Current length of the packet data segment. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:46:1 [INFO] [stdout] | [INFO] [stdout] 46 | / /// A [`Umem`](super::Umem) frame descriptor. [INFO] [stdout] 47 | | /// [INFO] [stdout] 48 | | /// Used to pass frame information between the kernel and [INFO] [stdout] 49 | | /// userspace. `addr` is an offset in bytes from the start of the [INFO] [stdout] ... | [INFO] [stdout] 52 | | /// length (in bytes) of any data stored in the frame's headroom or [INFO] [stdout] 53 | | /// data segments. [INFO] [stdout] | |__________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:61:1 [INFO] [stdout] | [INFO] [stdout] 61 | / impl FrameDesc { [INFO] [stdout] 62 | | /// Creates a new frame descriptor. [INFO] [stdout] 63 | | /// [INFO] [stdout] 64 | | /// `addr` must be the starting address of the packet data segment [INFO] [stdout] ... | [INFO] [stdout] 105 | | } [INFO] [stdout] 106 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:74:5 [INFO] [stdout] | [INFO] [stdout] 74 | / /// The starting address of the packet data segment of the frame [INFO] [stdout] 75 | | /// pointed at by this descriptor. [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:81:5 [INFO] [stdout] | [INFO] [stdout] 81 | / /// Current headroom and packet data lengths for the frame pointed [INFO] [stdout] 82 | | /// at by this descriptor. [INFO] [stdout] | |______________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:88:5 [INFO] [stdout] | [INFO] [stdout] 88 | /// Frame options. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:94:5 [INFO] [stdout] | [INFO] [stdout] 94 | /// Set the frame options. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:130:1 [INFO] [stdout] | [INFO] [stdout] 130 | /// Headroom segment of a [`Umem`](crate::umem::Umem) frame. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:136:1 [INFO] [stdout] | [INFO] [stdout] 136 | / impl<'umem> Headroom<'umem> { [INFO] [stdout] 137 | | pub(super) fn new(contents: &'umem [u8]) -> Self { [INFO] [stdout] 138 | | Self { contents } [INFO] [stdout] 139 | | } [INFO] [stdout] ... | [INFO] [stdout] 145 | | } [INFO] [stdout] 146 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:141:5 [INFO] [stdout] | [INFO] [stdout] 141 | /// Returns this segment's contents, up to its current length. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:171:1 [INFO] [stdout] | [INFO] [stdout] 171 | /// Mutable headroom segment of a [`Umem`](crate::umem::Umem) frame. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:178:1 [INFO] [stdout] | [INFO] [stdout] 178 | / impl<'umem> HeadroomMut<'umem> { [INFO] [stdout] 179 | | pub(super) fn new(len: &'umem mut usize, buf: &'umem mut [u8]) -> Self { [INFO] [stdout] 180 | | Self { len, buf } [INFO] [stdout] 181 | | } [INFO] [stdout] ... | [INFO] [stdout] 207 | | } [INFO] [stdout] 208 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:183:5 [INFO] [stdout] | [INFO] [stdout] 183 | /// Returns this segment's contents, up to its current length. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:189:5 [INFO] [stdout] | [INFO] [stdout] 189 | / /// Returns a mutable view of this segment's contents, up to its [INFO] [stdout] 190 | | /// current length. [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:196:5 [INFO] [stdout] | [INFO] [stdout] 196 | / /// A cursor for writing to this segment. [INFO] [stdout] 197 | | /// [INFO] [stdout] 198 | | /// Modifications via the cursor will change the length of the [INFO] [stdout] 199 | | /// segment, i.e. the headroom length of the frame descriptor. If [INFO] [stdout] ... | [INFO] [stdout] 202 | | /// [INFO] [stdout] 203 | | /// [`contents_mut`]: Self::contents_mut [INFO] [stdout] | |____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:254:1 [INFO] [stdout] | [INFO] [stdout] 254 | /// Packet data segment of a [`Umem`](crate::umem::Umem) frame. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:260:1 [INFO] [stdout] | [INFO] [stdout] 260 | / impl<'umem> Data<'umem> { [INFO] [stdout] 261 | | pub(super) fn new(contents: &'umem [u8]) -> Self { [INFO] [stdout] 262 | | Self { contents } [INFO] [stdout] 263 | | } [INFO] [stdout] ... | [INFO] [stdout] 271 | | } [INFO] [stdout] 272 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:265:5 [INFO] [stdout] | [INFO] [stdout] 265 | / /// Returns this segment's contents, up to its current length. [INFO] [stdout] 266 | | /// [INFO] [stdout] 267 | | /// Will change as packets are sent or received using this frame. [INFO] [stdout] | |_____________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:297:1 [INFO] [stdout] | [INFO] [stdout] 297 | / /// Mutable packet data segment of a [`Umem`](crate::umem::Umem) [INFO] [stdout] 298 | | /// frame. [INFO] [stdout] | |__________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:305:1 [INFO] [stdout] | [INFO] [stdout] 305 | / impl<'umem> DataMut<'umem> { [INFO] [stdout] 306 | | pub(super) fn new(len: &'umem mut usize, buf: &'umem mut [u8]) -> Self { [INFO] [stdout] 307 | | Self { len, buf } [INFO] [stdout] 308 | | } [INFO] [stdout] ... | [INFO] [stdout] 339 | | } [INFO] [stdout] 340 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:310:5 [INFO] [stdout] | [INFO] [stdout] 310 | / /// Returns this segment's contents, up to its current length. [INFO] [stdout] 311 | | /// [INFO] [stdout] 312 | | /// Will change as packets are sent or received using this frame. [INFO] [stdout] | |_____________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:318:5 [INFO] [stdout] | [INFO] [stdout] 318 | / /// Returns a mutable view of this segment's contents, up to its [INFO] [stdout] 319 | | /// current length. [INFO] [stdout] 320 | | /// [INFO] [stdout] 321 | | /// Will change as packets are sent or received using this frame. [INFO] [stdout] | |_____________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/frame/mod.rs:327:5 [INFO] [stdout] | [INFO] [stdout] 327 | / /// A cursor for writing to this segment. [INFO] [stdout] 328 | | /// [INFO] [stdout] 329 | | /// Modifications via the cursor will change the length of the [INFO] [stdout] 330 | | /// segment, i.e. the data length of the frame descriptor, and in [INFO] [stdout] ... | [INFO] [stdout] 334 | | /// [INFO] [stdout] 335 | | /// [`contents_mut`]: Self::contents_mut [INFO] [stdout] | |____________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:94:1 [INFO] [stdout] | [INFO] [stdout] 94 | / /// A region of virtual contiguous memory divided into equal-sized [INFO] [stdout] 95 | | /// frames. It provides the underlying working memory for an AF_XDP [INFO] [stdout] 96 | | /// [`Socket`](crate::socket::Socket). [INFO] [stdout] | |______________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:104:1 [INFO] [stdout] | [INFO] [stdout] 104 | / impl Umem { [INFO] [stdout] 105 | | /// Create a new `Umem` instance backed by an anonymous memory [INFO] [stdout] 106 | | /// mapped region. [INFO] [stdout] 107 | | /// [INFO] [stdout] ... | [INFO] [stdout] 326 | | } [INFO] [stdout] 327 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:105:5 [INFO] [stdout] | [INFO] [stdout] 105 | / /// Create a new `Umem` instance backed by an anonymous memory [INFO] [stdout] 106 | | /// mapped region. [INFO] [stdout] 107 | | /// [INFO] [stdout] 108 | | /// Setting `use_huge_pages` to `true` will instructed `mmap()` to [INFO] [stdout] ... | [INFO] [stdout] 111 | | /// `HugePages_Total` setting is non-zero when you run `cat [INFO] [stdout] 112 | | /// /proc/meminfo`. [INFO] [stdout] | |_______________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:200:5 [INFO] [stdout] | [INFO] [stdout] 200 | / /// The headroom and packet data segments of the `Umem` frame [INFO] [stdout] 201 | | /// pointed at by `desc`. Contents are read-only. [INFO] [stdout] 202 | | /// [INFO] [stdout] 203 | | /// # Safety [INFO] [stdout] ... | [INFO] [stdout] 218 | | /// [`TxQueue`]: crate::TxQueue [INFO] [stdout] 219 | | /// [`RxQueue`]: crate::RxQueue [INFO] [stdout] | |___________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:230:5 [INFO] [stdout] | [INFO] [stdout] 230 | / /// The headroom segment of the `Umem` frame pointed at by [INFO] [stdout] 231 | | /// `desc`. Contents are read-only. [INFO] [stdout] 232 | | /// [INFO] [stdout] 233 | | /// # Safety [INFO] [stdout] 234 | | /// [INFO] [stdout] 235 | | /// See [`frame`](Self::frame). [INFO] [stdout] | |___________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:242:5 [INFO] [stdout] | [INFO] [stdout] 242 | / /// The data segment of the `Umem` frame pointed at by [INFO] [stdout] 243 | | /// `desc`. Contents are read-only. [INFO] [stdout] 244 | | /// [INFO] [stdout] 245 | | /// # Safety [INFO] [stdout] 246 | | /// [INFO] [stdout] 247 | | /// See [`frame`](Self::frame). [INFO] [stdout] | |___________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:254:5 [INFO] [stdout] | [INFO] [stdout] 254 | / /// The headroom and packet data segments of the `Umem` frame [INFO] [stdout] 255 | | /// pointed at by `desc`. Contents are writeable. [INFO] [stdout] 256 | | /// [INFO] [stdout] 257 | | /// # Safety [INFO] [stdout] ... | [INFO] [stdout] 272 | | /// [`TxQueue`]: crate::TxQueue [INFO] [stdout] 273 | | /// [`RxQueue`]: crate::RxQueue [INFO] [stdout] | |___________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:287:5 [INFO] [stdout] | [INFO] [stdout] 287 | / /// The headroom segment of the `Umem` frame pointed at by [INFO] [stdout] 288 | | /// `desc`. Contents are writeable. [INFO] [stdout] 289 | | /// [INFO] [stdout] 290 | | /// # Safety [INFO] [stdout] 291 | | /// [INFO] [stdout] 292 | | /// See [`frame_mut`](Self::frame_mut). [INFO] [stdout] | |___________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:299:5 [INFO] [stdout] | [INFO] [stdout] 299 | / /// The data segment of the `Umem` frame pointed at by [INFO] [stdout] 300 | | /// `desc`. Contents are writeable. [INFO] [stdout] 301 | | /// [INFO] [stdout] 302 | | /// # Safety [INFO] [stdout] 303 | | /// [INFO] [stdout] 304 | | /// See [`frame_mut`](Self::frame_mut). [INFO] [stdout] | |___________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/umem/mod.rs:329:1 [INFO] [stdout] | [INFO] [stdout] 329 | /// Error detailing why [`Umem`] creation failed. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/socket/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | //! Types for creating and using an AF_XDP [`Socket`]. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/socket/mod.rs:72:1 [INFO] [stdout] | [INFO] [stdout] 72 | / /// An AF_XDP socket. [INFO] [stdout] 73 | | /// [INFO] [stdout] 74 | | /// More details can be found in the [INFO] [stdout] 75 | | /// [docs](https://www.kernel.org/doc/html/latest/networking/af_xdp.html) [INFO] [stdout] | |_________________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/socket/mod.rs:82:1 [INFO] [stdout] | [INFO] [stdout] 82 | / impl Socket { [INFO] [stdout] 83 | | /// Create and bind a new AF_XDP socket to a given interface and [INFO] [stdout] 84 | | /// queue id using the underlying UMEM. [INFO] [stdout] 85 | | /// [INFO] [stdout] ... | [INFO] [stdout] 212 | | } [INFO] [stdout] 213 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/socket/mod.rs:83:5 [INFO] [stdout] | [INFO] [stdout] 83 | / /// Create and bind a new AF_XDP socket to a given interface and [INFO] [stdout] 84 | | /// queue id using the underlying UMEM. [INFO] [stdout] 85 | | /// [INFO] [stdout] 86 | | /// May require root permissions to create successfully. [INFO] [stdout] ... | [INFO] [stdout] 105 | | /// For further details on using a shared [`Umem`] please see the [INFO] [stdout] 106 | | /// [docs](https://www.kernel.org/doc/html/latest/networking/af_xdp.html#xdp-shared-umem-bind-flag). [INFO] [stdout] | |________________________________________________________________________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/socket/mod.rs:224:1 [INFO] [stdout] | [INFO] [stdout] 224 | /// Error detailing why [`Socket`] creation failed. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:1:1 [INFO] [stdout] | [INFO] [stdout] 1 | / //! [`Umem`](crate::umem::Umem) and [`Socket`](crate::socket::Socket) [INFO] [stdout] 2 | | //! configuration. [INFO] [stdout] | |__________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:26:1 [INFO] [stdout] | [INFO] [stdout] 26 | /// A ring's buffer size. Must be a power of two. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:30:1 [INFO] [stdout] | [INFO] [stdout] 30 | / impl QueueSize { [INFO] [stdout] 31 | | /// Create a new `QueueSize` instance. Fails if `size` is not a [INFO] [stdout] 32 | | /// power of two. [INFO] [stdout] 33 | | pub fn new(size: u32) -> Result { [INFO] [stdout] ... | [INFO] [stdout] 44 | | } [INFO] [stdout] 45 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:31:5 [INFO] [stdout] | [INFO] [stdout] 31 | / /// Create a new `QueueSize` instance. Fails if `size` is not a [INFO] [stdout] 32 | | /// power of two. [INFO] [stdout] | |_____________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:41:5 [INFO] [stdout] | [INFO] [stdout] 41 | /// The queue size. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:55:1 [INFO] [stdout] | [INFO] [stdout] 55 | /// Error signifying incorrect queue size. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:67:1 [INFO] [stdout] | [INFO] [stdout] 67 | / /// The size of a [`Umem`](crate::umem::Umem) frame. Cannot be smaller [INFO] [stdout] 68 | | /// than [`XDP_UMEM_MIN_CHUNK_SIZE`]. [INFO] [stdout] | |_____________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:72:1 [INFO] [stdout] | [INFO] [stdout] 72 | / impl FrameSize { [INFO] [stdout] 73 | | /// Create a new `FrameSize` instance. Fails if `size` is smaller [INFO] [stdout] 74 | | /// than [`XDP_UMEM_MIN_CHUNK_SIZE`]. [INFO] [stdout] 75 | | pub fn new(size: u32) -> Result { [INFO] [stdout] ... | [INFO] [stdout] 86 | | } [INFO] [stdout] 87 | | } [INFO] [stdout] | |_^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:73:5 [INFO] [stdout] | [INFO] [stdout] 73 | / /// Create a new `FrameSize` instance. Fails if `size` is smaller [INFO] [stdout] 74 | | /// than [`XDP_UMEM_MIN_CHUNK_SIZE`]. [INFO] [stdout] | |_________________________________________^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:83:5 [INFO] [stdout] | [INFO] [stdout] 83 | /// The frame size. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: missing code example in this documentation [INFO] [stdout] --> src/config/mod.rs:97:1 [INFO] [stdout] | [INFO] [stdout] 97 | /// Error signifying incorrect frame size. [INFO] [stdout] | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ [INFO] [stdout] [INFO] [stdout] [INFO] [stdout] error: aborting due to 54 previous errors [INFO] [stdout] [INFO] [stdout] [INFO] [stderr] error: could not document `xsk-rs` [INFO] [stderr] [INFO] [stderr] Caused by: [INFO] [stderr] process didn't exit successfully: `rustdoc --edition=2018 --crate-type lib --crate-name xsk_rs src/lib.rs -o /opt/rustwide/target/doc --error-format=json --json=diagnostic-rendered-ansi,artifacts,future-incompat -Z unstable-options --document-private-items -C metadata=f3bc3dc8ed063592 -L dependency=/opt/rustwide/target/debug/deps --extern bitflags=/opt/rustwide/target/debug/deps/libbitflags-885ae3214f28c119.rmeta --extern cfg_if=/opt/rustwide/target/debug/deps/libcfg_if-483f5a2788925099.rmeta --extern libbpf_sys=/opt/rustwide/target/debug/deps/liblibbpf_sys-2050120cb198c53e.rmeta --extern libc=/opt/rustwide/target/debug/deps/liblibc-b2106559e686b889.rmeta --extern log=/opt/rustwide/target/debug/deps/liblog-e60afbaf99014ec3.rmeta --extern-html-root-url 'bitflags=https://docs.rs/bitflags/1.3.2/' --extern-html-root-url 'cfg_if=https://docs.rs/cfg-if/1.0.0/' --extern-html-root-url 'libbpf_sys=https://docs.rs/libbpf-sys/0.6.0-1/' --extern-html-root-url 'libc=https://docs.rs/libc/0.2.95/' --extern-html-root-url 'log=https://docs.rs/log/0.4.11/' -Zunstable-options --crate-version 0.4.1` (exit status: 1) [INFO] running `Command { std: "docker" "inspect" "52ab3aaa72cd5db37d80eab911d17e8bc942a64ab41d05e86560ca178ccd4556", kill_on_drop: false }` [INFO] running `Command { std: "docker" "rm" "-f" "52ab3aaa72cd5db37d80eab911d17e8bc942a64ab41d05e86560ca178ccd4556", kill_on_drop: false }` [INFO] [stdout] 52ab3aaa72cd5db37d80eab911d17e8bc942a64ab41d05e86560ca178ccd4556