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

doc: Update README for --enable-dev-mode #1091

Closed

Conversation

michaelfolkson
Copy link

Since #1079 the --enable-dev-mode flag turns on all experimental modules so update README to reflect this.

@real-or-random
Copy link
Contributor

real-or-random commented Mar 16, 2022

Hm, dev-mode was "hidden" on purpose. I don't think we should encourage people to enable experimental modules, at least not without calling them "experimental" explicitly. Maybe adding the text to the README was actually an oversight in the PR that added examples.

@real-or-random
Copy link
Contributor

In fact, after #1091 we won't have experimental modules, so #1091 should remove the sentence "For experimental modules, you will also need --enable-experimental as well as a flag for each individual module, e.g. --enable-module-ecdh." This was overlooked because the PR was opened before this text existed.

This will resolve the problem for that part in the README, and I feel the README is the wrong place to mention the option. There's also reason why ./configure --help doesn't show it. I think it would be okay to document the option in some development docs (but we don't have development docs, and adding them just to point this out seems overkill.)

@michaelfolkson
Copy link
Author

Ok no worries, closing.

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