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.

Sign up for GitHub

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

Jump to bottom

Add mentions and links to honggfuzz-rs #14

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add mentions and links to honggfuzz-rs #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
53ae82f
Add a mention to honggfuzz-rs
PaulGrandperrin Oct 13, 2018
cf8423d
Add honggfuzz-rs documentation links
PaulGrandperrin Oct 13, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,12 @@
* [Tutorial](./cargo-fuzz/tutorial.md)
* [Guide](./cargo-fuzz/guide.md)
* [Targets](./cargo-fuzz/targets.md)
* [Fuzzing wth afl.rs](./afl.md)
* [Fuzzing with afl.rs](./afl.md)
* [Setup](./afl/setup.md)
* [Tutorial](./afl/tutorial.md)
* [Fuzzing with honggfuzz-rs](https://crates.io/crates/honggfuzz)
* [Setup](https://crates.io/crates/honggfuzz#dependencies)
* [Tutorial/Guide](https://crates.io/crates/honggfuzz#how-to-use-this-crate)
* [API](https://docs.rs/honggfuzz)
* [Related docs](https://crates.io/crates/honggfuzz#relevant-documentation-about-honggfuzz)
Copy link
Member

Choose a reason for hiding this comment

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

Oh? Does mdbook support external links in the TOC?

Copy link
Member Author

Choose a reason for hiding this comment

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

I have no idea, I didn't test anything, just edited in github directly.

Copy link
Member

Choose a reason for hiding this comment

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

Just tried rendering this branch with mdbook. It appears mdbook adds a .html to the end of each of the external links, causing them to break. We might just need to create a new dedicated page for hongfuzz within this book containing all these links

* [Trophy case](./trophy-case.md)
3 changes: 2 additions & 1 deletion src/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@

This book will demonstrate how to perform fuzz testing for software written in Rust.

There are two tools for fuzzing Rust code documented in this book: **[afl.rs]** and **[cargo-fuzz]**.
There are three tools for fuzzing Rust code: **[afl.rs]** and **[cargo-fuzz]** which are documented in this book; and **[honggfuzz-rs]** which is documented on its homepage.

[Fuzz testing]: https://en.wikipedia.org/wiki/Fuzz_testing
[Rust]: https://www.rust-lang.org/
[cargo-fuzz]: cargo-fuzz.html
[afl.rs]: afl.html
[honggfuzz-rs]: https://crates.io/crates/honggfuzz