google/benchmark

Better docs/name needed for "multi-threaded" benchmarking

Open

#813 opened on May 2, 2019

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (1,539 forks)batch import
docshelp wanted

Repository metrics

Stars
 (7,968 stars)
PR merge metrics
 (Avg merge 4d 2h) (19 merged PRs in 30d)

Description

Would it have been better if any of this would be in docs / is there anything brought up in this issue appears to be omitted in docs?

I think so, yes. Perhaps a sentence or two on the README regarding how the "multi-threaded" implementation spawns self-contained benchmark instances, and users should expect memory footprint for the benchmark program to grow linearly in the number of threads.

Originally posted by @jmftrindade in https://github.com/google/benchmark/issues/806#issuecomment-488472617

Contributor guide

Research direction
Examine the current README and add a brief explanation about multi threaded benchmark instance spawning and linear memory growth.
Tech stack
cpp
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Familiarity with the benchmark library
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90