mapbox / mapbox/cpp

Add demangle to glossary

Open
#50 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

glossary
Dominant language
No language data
Stars
110
Forks
17
PR merge metrics
No merged PRs in 30d

Description

Add a discussion of mangled symbols to the glossary and a mention of how to use c++filt to demangle them. Make this relevant by noting that even the latest and greatest C++ libraries have to deal with this like https://github.com/abseil/abseil-cpp/commit/dca2eb50f9f5ee378395ee020953dc20a2a84c97

Contributor guide

Open the contributing guide

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

Locate the repository's glossary and review its existing entries and style. Add a discussion of mangled symbols, explain how to use c++filt to demangle them, and include the requested context that current C++ libraries still encounter this issue, referencing the linked Abseil commit.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.