Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve CMake docs #985

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

generic-pers0n
Copy link

@generic-pers0n generic-pers0n commented Nov 22, 2024

This PR intends to solve #662 by updating the documentation to better cover CMake.

Note that as far as I understand, it appears that the process of building with CMake hasn't changed much and remains fundamentally the same even after #461 and the subsequent PRs, maybe perhaps with a few changes in targets and build options. I could be extremely wrong, but either way, I try to cover the changes in target names from 19.7 to the latest development version and also add a full list of CMake build options. I also mention Ninja as an alternative to the traditional make since it also works in the same way as it too.

I'm currently marking this draft as a PR because I'm looking at refining more of the build documentation given #662 (comment). Early feedback is appreciated, but always keep in mind that things will change! 😄

EDIT: I forgot to mention that I saw #963, and I just want to say that this PR can be updated to reflect any changes should that PR get merged before this one. (It might be preferable to have that PR merged before this one).

@RossBencina RossBencina added documentation Improvements or additions to documentation build-cmake CMake build system P2 Priority: High labels Nov 25, 2024
@RossBencina RossBencina added this to the V19.8 milestone Nov 25, 2024
@RossBencina
Copy link
Collaborator

Fantastic that you are working on this, it's much appreciated. I agree that #963 should be merged first. Phil and I were hoping that we could get some feedback from CMake users before merging it.

@RossBencina
Copy link
Collaborator

We've merged #963

doc/src/tutorial/compile_cmake.dox Outdated Show resolved Hide resolved
@generic-pers0n generic-pers0n marked this pull request as ready for review November 26, 2024 16:07
@generic-pers0n
Copy link
Author

Since #963 was merged, I'm marking this PR as ready to review.

I also have one question: should we recommend CMake over the other build systems? I can try to chip in whenever other CMake related PRs come up, although I don't consider myself a "CMake expert" but can try to help out whenever I can anyways.

(And I know it's late, but I think #963 was fine, especially considering I was operating under the assumption of its eventual merge).

@RossBencina
Copy link
Collaborator

Your offer of ongoing assistance is much appreciated.

should we recommend CMake over the other build systems?

Not for the forseeable future.

doc/src/tutorial/compile_cmake.dox Outdated Show resolved Hide resolved
doc/src/tutorial/compile_cmake.dox Outdated Show resolved Hide resolved
doc/src/tutorial/compile_cmake.dox Outdated Show resolved Hide resolved
- Update target names
- Mention auto-download of ASIO SDK
- Mention Ninja for Linux and OS X
Copy link
Collaborator

@philburk philburk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for addressing my comments. We will test the current docs before merging.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-cmake CMake build system documentation Improvements or additions to documentation P2 Priority: High
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants