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 descriptions of build flags and the build guide #2716

Open
harendra-kumar opened this issue Feb 2, 2024 · 0 comments
Open

Update descriptions of build flags and the build guide #2716

harendra-kumar opened this issue Feb 2, 2024 · 0 comments
Milestone

Comments

@harendra-kumar
Copy link
Member

All the build flags in streamly (except maybe the has-llvm flag) are development only flags. We can make the flag descriptions more explicit mentioning that end-users should not try those unless they know what they are doing. The flags are unsupported for production use and are only to be enabled if recommended by the developers for a specific case (e.g. debugging something). We can mention this in the build guide as well.

An alternative is to remove the flags before uploading the release to hackage, but it has some downsides:

  • Some flags like debug may be risky to use, but they could be useful for users to debug the code.
  • Some flags like has-llvm even though not well-tested are likely to work and users who want to try them can still use.
  • It will add additional overhead in the release process.

We should only remove the flags that change the API (dev and use-unliftio as of now).

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

No branches or pull requests

1 participant