approvals / approvals/ApprovalTests.cpp

Implement a helpful missing-symbol error for misconfigured main

Open
#145 3 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
C++
Stars
339
Forks
55
PR merge metrics
No merged PRs in 30d

Description

We want to make a linker error something like this:

"__APPROVAL_MAIN_NOT_CONFIGURED::See_TroubleshootingMisconfiguredMain_Documentation::check()", referenced from:

But the initial underscore if global, and the double underscores are reserved.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining how a misconfigured main is detected and how the linker reports the missing symbol, including the referenced TroubleshootingMisconfiguredMain_Documentation::check() entry point. Reproduce the current failure on the relevant platform and define the work as complete when the linker output clearly directs users to the misconfigured-main troubleshooting documentation without relying on reserved symbol names.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
testing
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.