cameron314 / cameron314/concurrentqueue

Consider reviewing the include path for a CMake install

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

Nobody has claimed this yet.

Dominant language
C++
Stars
12.5k
Forks
1.9k
PR merge metrics
No merged PRs in 30d

Description

The CMake-based build+install works, but it ends up installing the header files in include/concurrentqueue/moodycamel. This forces client code to use this header inclusion:

#include <concurrentqueue/moodycamel/blockingconcurrentqueue.h>

While it would be preferable a simpler path, as this.

#include <concurrentqueue/blockingconcurrentqueue.h>

This is also the path taken by the concurrentqueue installation through Vcpkg and it is in the best interest for the spreading of the library that the two approaches are exactly the same.
The line responsible for this, and the only one that should need to be changed is the following.

https://github.com/cameron314/concurrentqueue/blob/6dd38b8a1dbaa7863aa907045f32308a56a6ff5d/CMakeLists.txt#L61

Changed to this.

    ${CMAKE_INSTALL_INCLUDEDIR}/${PROJECT_NAME}

I could take care of the change, but I need to understand there's agreement on it.
Will this change find acceptance?

NOTE:
Should it be critical to keep the word moodycamel in the path I'd suggest a more intuitive path.

#include <moodycamel/concurrentqueue/blockingconcurrentqueue.h>

The name of the organization (moodycamel) has a broader scope than the name of the library (concurrentqueue), it feel really weird that the two are inverted.

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 at CMakeLists.txt line 61 and review how the CMake install destination produces the current include/concurrentqueue/moodycamel path. Compare the desired path with the Vcpkg installation behavior mentioned in the issue. Done means the CMake-installed headers use the agreed include/concurrentqueue layout without breaking the install configuration.

Written by the indexing model from the issue text.

Assessment

Tech stack
cmake, cpp
Domain
build-system
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.