google/benchmark

CMake: Difference between benchmark::benchmark and benchmark::benchmark_main

Open

#1856 opened on Sep 18, 2024

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

Description

Hi, I saw that on https://github.com/google/benchmark?tab=readme-ov-file#usage-with-cmake the Readme indicates that I should link against both benchmark::benchmark and benchmark::benchmark_main when using CMake. What's the difference between the two? Wouldn't it be enough to just link against benchmark::benchmark_main?

Thanks.

Contributor guide

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.
needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
None
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
The issue asks for clarification on the difference between the two CMake targets. The answer likely lies in the CMakeLists.txt file where these targets are defined. The maintainer should explain that benchmark::benchmark main provides a default main() function, while benchmark::benchmark provides the library without main. The documentation should be updated accordingly.