Improve baby_fuzzer chapter of the documentation
#1289
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Specifically: - Explicitly mention that the dependency path must point to a specific directory in the cloned repo (and not the root directory) - Explicitly mention how to manually trigger the panic in the harness for testing purposes
Since the baby fuzzer chapter of the documentation is done in a "tutorial", step-by-step fashion, it would be nice to be able to see where exactly new lines have to be placed in the existing code. To that end, the code used in the tutorial is moved to snippets (as is done in the Rust Book), as it allows for much more convenient maintenance of the snippets, as well as easy hiding of the non-important code on any given snippet. Furthermore, a few minor fixes are applied; a typo on a comment and a missing unsafe block.
Closed
|
This looks awesome! |
Specifically: - Remove unnecessary `compile_fail` attribute - Add `ignore` attribute to the snippets of the complete baby fuzzer. As explained in [AFLplusplus#1290], it is expected for the baby fuzzer to return a non-0 exit code, so this should not trigger a failure during `mdbook test`.
For CLI snippets, the "language" should be set to `console`.
|
Thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Restructure the
baby_fuzzerchapter to use listings instead of hardcoded snippets, to allow for better maintenance and hiding/showing relevant parts of code, to reveal how new snippets fit in the complete fuzzer.