AFLplusplus / LibAFL

Advanced Fuzzing Library - Slot your Fuzzer together in Rust! Scales across cores and machines. For Windows, Android, MacOS, Linux, no_std, ...
Other
1.9k stars 292 forks source link

Fix publish errors #2313

Closed andreafioraldi closed 2 weeks ago

andreafioraldi commented 2 weeks ago

It is inconsistent between cargo publish and cargo check (so either broken ci or broken publish), also I don't think we need to include the readme in the source for doc as we don't do it for other crates.

The best thing is a libafl qemu readme btw, but another pr for it.

Il sab 15 giu 2024, 11:08 Dominik Maier @.***> ha scritto:

@.**** commented on this pull request.

In libafl_qemu/src/lib.rs https://github.com/AFLplusplus/LibAFL/pull/2313#discussion_r1640934410:

@@ -1,7 +1,6 @@ //! Welcome to LibAFL QEMU //! //! Warning: The documentation is built by default for x86_64 in usermode. To access the documentation of other architectures or systemmode, the documentation must be rebuilt with the right features. -#![doc = include_str!("../../README.md")]

We want a readme I think?

— Reply to this email directly, view it on GitHub https://github.com/AFLplusplus/LibAFL/pull/2313#pullrequestreview-2120287843, or unsubscribe https://github.com/notifications/unsubscribe-auth/AD3LJ6QWQGFKXXFWA2FHAYDZHQAATAVCNFSM6AAAAABJK3TJYWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDCMRQGI4DOOBUGM . You are receiving this because you authored the thread.Message ID: @.***>

andreafioraldi commented 2 weeks ago

https://docs.rs/crate/libafl_qemu/0.13.0/builds/1249866

all the include_str from paths outside the crate itself are broken

Il sab 15 giu 2024, 12:27 Andrea Fioraldi @.***> ha scritto:

It is inconsistent between cargo publish and cargo check (so either broken ci or broken publish), also I don't think we need to include the readme in the source for doc as we don't do it for other crates.

The best thing is a libafl qemu readme btw, but another pr for it.

Il sab 15 giu 2024, 11:08 Dominik Maier @.***> ha scritto:

@.**** commented on this pull request.

In libafl_qemu/src/lib.rs https://github.com/AFLplusplus/LibAFL/pull/2313#discussion_r1640934410:

@@ -1,7 +1,6 @@ //! Welcome to LibAFL QEMU //! //! Warning: The documentation is built by default for x86_64 in usermode. To access the documentation of other architectures or systemmode, the documentation must be rebuilt with the right features. -#![doc = include_str!("../../README.md")]

We want a readme I think?

— Reply to this email directly, view it on GitHub https://github.com/AFLplusplus/LibAFL/pull/2313#pullrequestreview-2120287843, or unsubscribe https://github.com/notifications/unsubscribe-auth/AD3LJ6QWQGFKXXFWA2FHAYDZHQAATAVCNFSM6AAAAABJK3TJYWVHI2DSMVQWIX3LMV43YUDVNRWFEZLROVSXG5CSMV3GSZLXHMZDCMRQGI4DOOBUGM . You are receiving this because you authored the thread.Message ID: @.***>

domenukk commented 2 weeks ago

Yes a readme for each create would be best