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 the docs for building the C API #8960

Merged
merged 2 commits into from
Jul 15, 2024

Conversation

fitzgen
Copy link
Member

@fitzgen fitzgen commented Jul 15, 2024

Suggest cmake since that is what we test in CI and keep working.

Suggest `cmake` since that is what we test in CI and keep working.
@fitzgen fitzgen requested review from a team as code owners July 15, 2024 21:02
@fitzgen fitzgen requested review from pchickey and removed request for a team July 15, 2024 21:02
Copy link
Member

@alexcrichton alexcrichton 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 this! Mind rewording this though based on cmake --build target/c-api --target install? Basically the "install" target should be run to produce the final output structure of the include dir and the lib dir which will have all the relevant artifacts. That'll avoid the need to document the internals of the build directory and asking users to weave together everything themselves.

For documentation if the link isn't already here we should also link to https://docs.wasmtime.dev/c-api/ to avoid users needing to install/configure doxygen themselves locally.

@alexcrichton alexcrichton enabled auto-merge July 15, 2024 21:57
@alexcrichton alexcrichton added this pull request to the merge queue Jul 15, 2024
Merged via the queue into bytecodealliance:main with commit 158a8f5 Jul 15, 2024
39 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants