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

Update CMake instructions in the PortAudio Tutorial #662

Open
philburk opened this issue Nov 12, 2021 · 7 comments
Open

Update CMake instructions in the PortAudio Tutorial #662

philburk opened this issue Nov 12, 2021 · 7 comments
Labels
build build-cmake CMake build system documentation Improvements or additions to documentation P2 Priority: High
Milestone

Comments

@philburk
Copy link
Collaborator

philburk commented Nov 12, 2021

We describe using ./configure but CMake is now a good alternative and should be documented.

Document building libraries, examples, tests and MSVC projects.

@philburk philburk changed the title Add CMAKE instructions to the PortAudio Tutorial Add more CMake instructions to the PortAudio Tutorial Nov 12, 2021
@RossBencina
Copy link
Collaborator

The existing CMake build instructions are here:

http://files.portaudio.com/docs/v19-doxydocs/compile_cmake.html

The source is here if anyone would like to edit it and submit a PR:

https://github.com/PortAudio/portaudio/blob/master/doc/src/tutorial/compile_cmake.dox

Off the top of my head one thing that should be covered is how to build shared vs. static lib as I think this has changed.

We should also clean up the build instruction links here to make it clear what build systems we support:

http://files.portaudio.com/docs/v19-doxydocs/tutorial_start.html

@RossBencina RossBencina added build build-cmake CMake build system labels Nov 12, 2021
@Be-ing
Copy link
Collaborator

Be-ing commented Nov 12, 2021

I'll make a PR soon.

@philburk
Copy link
Collaborator Author

I found that this sequence worked to build the examples and tests:

mkdir cbuild
cd cbuild
cmake -DPA_BUILD_EXAMPLES=ON  -DPA_BUILD_TESTS=ON ..
make
examples/paex_sine

@RossBencina RossBencina added the P2 Priority: High label Feb 3, 2022
@RossBencina RossBencina added the documentation Improvements or additions to documentation label Mar 10, 2022
@RossBencina
Copy link
Collaborator

Related #486

@RossBencina
Copy link
Collaborator

@Be-ing please fix this, it's a P2 and we're getting complaints:

#748

@philburk philburk changed the title Add more CMake instructions to the PortAudio Tutorial Update CMake instructions in the PortAudio Tutorial Jan 5, 2024
@RossBencina RossBencina added this to the V19.8 milestone Jul 25, 2024
@RossBencina
Copy link
Collaborator

RossBencina commented Aug 22, 2024

I've made PR #951 to update the docs with warnings and annotations about inconsistencies between our docs and CMake

Honestly this is a disgrace. I should not have approved the merge of CMakeLists.txt changes without accompanying updates to the documentation. With this ticket being open for almost 3 years, with no PortAudio CMake developers stepping up to fix it, the obvious conclusion is that CMake is an unsupported build system for PortAudio.

@RossBencina
Copy link
Collaborator

Removed @Be-ing as assignee, clearly they have moved on.

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

No branches or pull requests

3 participants