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

add benchmark for stumpless_open_buffer_target #449

Closed
goatshriek opened this issue Sep 27, 2024 · 2 comments
Closed

add benchmark for stumpless_open_buffer_target #449

goatshriek opened this issue Sep 27, 2024 · 2 comments
Labels
good first issue something that would be simple for a newcomer to stumpless to work on help wanted external contributations encouraged testing pertains to the test suite

Comments

@goatshriek
Copy link
Owner

Buffer targets are use heavily in test suites, and will also be employed internally for new features. Adding a benchmark test for stumpless_open_buffer_target will give future changes a way to evaluate what the impact to performance is.

General Approach

There are a few details left out of the following approach, for you to fill in as you encounter them. If you find you need help, please ask here or on the project gitter and someone can help you get past the stumbling block.

First, read the documentation on benchmarking in stumpless. This doc walks through the general philosophy behind benchmark tests and how they are used in this project.

Once you understand these concepts, you'll be ready to add a new benchmark suite as test/performance/target/buffer.cpp for stumpless_open_buffer_target. Look to the existing test suites as a starting point for your new one. To add the new benchmark suite to the build process, you'll need to modify CMakeLists.txt with a call to add_performance_test for the new benchmark suite. Make sure that you are able to see results from your new test when you run the benchmark suite using the bench make target.

@goatshriek goatshriek added help wanted external contributations encouraged testing pertains to the test suite good first issue something that would be simple for a newcomer to stumpless to work on hacktoberfest labels Sep 27, 2024
@m3g4d1v3r
Copy link
Contributor

m3g4d1v3r commented Oct 15, 2024

Hello there!
I've opened a pull request in order to solve this issue.
#466
It's still a Work In Progress.

@goatshriek
Copy link
Owner Author

Resolved by #466

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue something that would be simple for a newcomer to stumpless to work on help wanted external contributations encouraged testing pertains to the test suite
Projects
None yet
Development

No branches or pull requests

2 participants