Skip to content

Run documentation examples with cargo test #610

Closed
@andreeaflorescu

Description

@andreeaflorescu

The documentation examples should be run along with the unit tests. Currently, cargo test does not run the examples because cargo does not have support for running doc tests when cross-compiling.
Cargo test issue: rust-lang/cargo#2684

A possible workaround would be to skip the crates that cannot be built with gnu (one of them is x86 as far as I remember because some ioctl have different parameters).
Another workaround is making firecracker buildable with both gnu and musl and run the unit tests with both.

There might be other solutions out there.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Good first issueIndicates a good issue for first-time contributorsPriority: MediumIndicates than an issue or pull request should be resolved ahead of issues or pull requests labelled

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions