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

docs: start updating docs for CMake #1270

Merged
merged 11 commits into from
Oct 17, 2023
Merged

Conversation

cosmin
Copy link
Collaborator

@cosmin cosmin commented Sep 27, 2023

I took a pass at updating the build docs for Linux and Mac and Windows.

I also started updating the Linux profiling docs to remove references to things that don't work anymore. We can take another pass at that after actually integrating gperftools into CMake. Likewise for adding easy to use build modes for various sanitizers.

I propose we leave the gperftools and sanitizers enhancements to the build for after the merge of cmake into main since it's holding up feature and bug fixes. And we can continue to iterate on the build system.

@cosmin cosmin marked this pull request as draft September 27, 2023 01:51
@cosmin cosmin changed the title start updating docs docs: start updating docs for CMake (wip) Sep 27, 2023
@cosmin cosmin marked this pull request as ready for review September 27, 2023 16:19
@cosmin cosmin assigned cosmin and unassigned cosmin Sep 27, 2023
@cosmin cosmin changed the title docs: start updating docs for CMake (wip) docs: start updating docs for CMake Oct 13, 2023
@joeyparrish
Copy link
Member

I'm pushing a few edits. PTAL when you can. If you approve of my edits, feel free to merge.

@cosmin cosmin merged commit 4cedb7c into shaka-project:cmake Oct 17, 2023
31 checks passed
@cosmin cosmin deleted the cmake-docs branch October 17, 2023 16:39
@github-actions github-actions bot added the status: archived Archived and locked; will not be updated label Dec 16, 2023
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Dec 16, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status: archived Archived and locked; will not be updated
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants