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

Improvements to Documentation #999

Open
incaseoftrouble opened this issue Feb 23, 2024 · 1 comment · May be fixed by #1023
Open

Improvements to Documentation #999

incaseoftrouble opened this issue Feb 23, 2024 · 1 comment · May be fixed by #1023
Labels
documentation

Comments

@incaseoftrouble
Copy link
Contributor

I want to provide some improvement suggestions to the documentation after understanding more about benchexec.

In particular, add a clearer overview of what which tool is doing, how it can be used, etc. in README and a concise user guide.

This issue is mainly to track that I want to do this and don't forget it :)
@incaseoftrouble incaseoftrouble linked a pull request Mar 24, 2024 that will close this issue
Draft
PhilippWendler added a commit that referenced this issue May 21, 2024
@PhilippWendler @incaseoftrouble
Tweak advertisement and connections between tools in documentation
48cfd9b 
We want to make it clear that BenchExec is not only benchexec
and one can use runexec on its own as a replacement for time.
This is not mentioned in the README and also not prominently
in the documentation, and has led to misunderstandings
about BenchExec in the past.

In particular, we want to advertise runexec for users
who already have their own benchmarking scripts,
while still advertising benchexec as the main and recommended solution
in general for most users.
For this it seems useful to make the connections
between the tools more explicit in the documentation.

This commit is an outcome of the discussion in #1031
and implements a part of what is suggested in #999 and #1031.

Co-authored-by: Tobias Meggendorfer <tobias@meggendorfer.de>
@PhilippWendler
Copy link
Member

For the record: Some improvements clarifying that runexec is usable standalone were made in the linked commit (resulting from discussion in #1031).

Current plan for further improvement is a quickstart tutorial that reviewers can link for "how to do better benchmarking easily" as discussed in #1031 (comment) and the following comments.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Draft: Improveme Documentation incaseoftrouble/benchexec
2 participants
@PhilippWendler @incaseoftrouble