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

Suggestions to improve the documentation #65

Open
kerneis-anssi opened this issue Mar 13, 2024 · 1 comment
Open

Suggestions to improve the documentation #65

kerneis-anssi opened this issue Mar 13, 2024 · 1 comment
Assignees

Comments

@kerneis-anssi
Copy link

Thanks a lot for this tool and its detailed documentation which make it easy to get started.

A few things I noticed while following the provided instructions:

  • you should add libXpm and gtk2 to the list of dependencies on https://intel.github.io/tsffs/setup/linux.html#install-local-dependencies
  • https://intel.github.io/tsffs/fuzzing/compatibility.html uses test.efi to test micro-checkpoints, but the sample output ("Working...") corresponds to HelloWorld.efi from the tutorial section. It is a good thing to prefer test.efi here (since it doesn't require docker to compile), you should just update the text to mention the expected output is "4141414141414141" rather than "Working..."
  • in the same section, you should use ./build.sh rather than ninja to build, otherwise the tsffs header is missing and linking fails.
@novafacing
Copy link
Contributor

Thanks for the notes, I'll incorporate these suggestions in the next docs update.

@novafacing novafacing self-assigned this Mar 13, 2024
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

No branches or pull requests

2 participants