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

Add default building behavior to the documentation #855

Open
dariuszd21 opened this issue Sep 24, 2024 · 1 comment
Open

Add default building behavior to the documentation #855

dariuszd21 opened this issue Sep 24, 2024 · 1 comment
Labels
Enhancement New feature or request Triaged

Comments

@dariuszd21
Copy link
Contributor

dariuszd21 commented Sep 24, 2024

What needs to get done

Update cmake documentation with the information about the possibility of changing the build type to release with an example. It should encourage user to change it for the packaged application, so the resulting binary is more optimized and does not have an unnecessary debug information

As a bonus point we may look into other plugins like rust and add it there as well.

Why it needs to get done

User may not be aware, that the build system is building libraries and applications in Debug mode by default.
We should clearly state in the documentation that this is a case, and add and information about possibility of changing that.

@dariuszd21 dariuszd21 added Enhancement New feature or request Triaged labels Sep 24, 2024
Copy link

Thank you for reporting us your feedback!

The internal ticket has been created: https://warthogs.atlassian.net/browse/CRAFT-3456.

This message was autogenerated

@dariuszd21 dariuszd21 changed the title Fill the documentation with the default behavior of the plugins Add default building behavior to the documentation Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature or request Triaged
Projects
None yet
Development

No branches or pull requests

1 participant