Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prep for publishing libafl_libfuzzer #1457

Merged
merged 6 commits into from
Aug 24, 2023
Merged

Prep for publishing libafl_libfuzzer #1457

merged 6 commits into from
Aug 24, 2023

Conversation

addisoncrump
Copy link
Collaborator

This wraps up some last minute items to prepare the publishing of libafl_libfuzzer.

@addisoncrump addisoncrump requested a review from domenukk August 24, 2023 12:48
@domenukk
Copy link
Member

Woot woot!

))]
#![cfg_attr(test, deny(
missing_debug_implementations,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this not checked in CI?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure, I thought it was but apparently somehow missed.

@domenukk
Copy link
Member

error: item in documentation is missing backticks
 --> libafl_libfuzzer/src/lib.rs:5:12
  |
5 | //! To use LibAFL in place of libfuzzer, change the following line in your fuzz/Cargo.toml:
  |            ^^^^^^

@@ -1,5 +1,68 @@
//! `libafl_libfuzzer` offers a "permanent" replacement for the now-deprecated libfuzzer
//!
//! ## Usage
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Want to copy&paste this into the book as well? might make sense (or include it from there)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe it's too technical

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not too technical. Makes sense to include it since many folks might be coming from libfuzzer.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What section should it be put under? Its own? It can be used with both C/C++ and Rust targets but needs different setups.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure sounds like an extra section to me

@domenukk domenukk merged commit 9aa40c0 into main Aug 24, 2023
@domenukk domenukk deleted the libfuzzer-publish branch August 24, 2023 18:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants