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

Document nimble build options, esp. -d:release #812

Closed
snej opened this issue Jun 18, 2020 · 5 comments
Closed

Document nimble build options, esp. -d:release #812

snej opened this issue Jun 18, 2020 · 5 comments

Comments

@snej
Copy link

snej commented Jun 18, 2020

Please document the options/flags the nimble build command takes. There are currently no docs that I can find; the help text just says "[opts, ...]", and the README just says it builds in debug mode.

Justification: Yesterday I tried to build and profile an optimized version of my code, and spent more than an hour trying to figure out why it was so slow — it looked like there was a terrible bottleneck in the Table class. See this forum thread. The answer turned out to be that I didn't have an optimized build at all — I had put -d:release in my nim.cfg file, where it didn't work, instead of putting it on the command line after nimble build. I did this because I knew compiler flags could be put in the config file, and I had no idea what flags could be used with nimble build.

I know nimble build is used during development, and normally that implies a debug configuration, but it's not unusual to do profiling, or check binary sizes, during development too.

@SolitudeSF
Copy link
Contributor

nimble build just forwards arguments to compiler. read nim --fullhelp

@ghost
Copy link

ghost commented Jun 18, 2020

That's not a Nimble bug - see nim-lang/Nim#14272

@snej
Copy link
Author

snej commented Jun 20, 2020

nimble build just forwards arguments to compiler.

Great. Then document that in the help text and the README, please.

@dom96
Copy link
Collaborator

dom96 commented Jun 27, 2020

Then document that in the help text and the README, please.

PRs for this should be easy, please? :)

@genotrance
Copy link
Contributor

This is now covered in the nimble docs.

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

4 participants