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 --trace-compile= flag to --help-hidden output. #31072

Merged
merged 2 commits into from
Sep 30, 2019

Conversation

NHDaly
Copy link
Member

@NHDaly NHDaly commented Feb 14, 2019

The --trace-compile=stderr flag was very helpful for us to understand what's going on in our system! :)

This PR just adds the flag to the list of flags in julia --help-hidden.

@NHDaly
Copy link
Member Author

NHDaly commented Feb 14, 2019

Was this not documented on purpose, because it's not a stable API or something? If so we could maybe just mark it EXPERIMENTAL or something?

And assuming that you don't mind this being documented, maybe I'll also add it to the docs pages?

@KristofferC
Copy link
Sponsor Member

Seems good to me to have this documented.

@KristofferC
Copy link
Sponsor Member

However, I think the docs is slightly wrong. The argument is a file name with only stderr being special cased to print to stderr (unless it has been changed since the original implementation).

@JeffBezanson
Copy link
Sponsor Member

Right, we have been very conservative about what we document. Once this goes in the help, we can't change it :|

@maleadt
Copy link
Member

maleadt commented Feb 15, 2019

Maybe this would be a better fit for --help-hidden, seeing how not many users would ever want to use this flag? Other options there seem like they might change too.

NHDaly and others added 2 commits July 1, 2019 16:26
Since the `--trace-compile` flag is an unsupported, experimental flag, we don't want to document it in `--help`, which has forward maintainability requirements. Instead, we will put the help string in `--help-hidden`, which contains documentation for unsupported flags.
@NHDaly
Copy link
Member Author

NHDaly commented Jul 1, 2019

Thanks for the advice @maleadt. Sorry it took me so long to respond to it! I've moved the help string to --help-hidden, rebased, and repushed. PTAL! :)
Thanks!

@NHDaly NHDaly changed the title Add --trace-compile= flag to --help output. Add --trace-compile= flag to --help-hidden output. Jul 1, 2019
@NHDaly NHDaly closed this Sep 17, 2019
@NHDaly NHDaly reopened this Sep 17, 2019
@StefanKarpinski StefanKarpinski merged commit 6cf8dba into JuliaLang:master Sep 30, 2019
@NHDaly NHDaly deleted the document--trace-compile branch October 2, 2019 23:36
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.

None yet

5 participants