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.

Sign up for GitHub

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

Jump to bottom

Docs: Update man page with new options (#5554) #6259

Merged
merged 3 commits into from Jun 27, 2018
Merged

Docs: Update man page with new options (#5554) #6259

merged 3 commits into from Jun 27, 2018

Conversation

docelic
Copy link
Contributor

@docelic docelic commented Jun 25, 2018

Updates the crystal man page with all new options from Crystal 0.25.0.
Also adds a missing argument to option --threads in the binary's built-in docs.

RX14
RX14 approved these changes Jun 25, 2018
View reviewed changes
Copy link
Contributor

@RX14 RX14 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! Perhaps we should document CRYSTAL_PATH and CRYSTAL_CACHE_DIR env vars here too.

@RX14
Copy link
Contributor

RX14 commented Jun 25, 2018

CRYSTAL_PATH and CRYSTAL_CACHE_DIR are read by the compiler - so they should be in a seperate top-level section down the bottom called ENVIRONMENT VARIABLES, see man grep for example.

CRYSTAL_VERSION isn't read by the compiler, it's only emitted by crystal env informationally, so should be documented under crystal env. The other two env vars should just refer to the ENVIRONMENT VARIABLES section.

@docelic
Copy link
Contributor Author

docelic commented Jun 26, 2018

Man page updated to reflect the requested changes. Thanks!

@sdogruyol
Copy link
Member

Thanks @docelic 👍

@sdogruyol sdogruyol merged commit b6ef064 into crystal-lang:master Jun 27, 2018
@bcardiff bcardiff added this to the 0.25.1 milestone Jun 27, 2018
@wooster0 wooster0 mentioned this pull request Aug 26, 2018
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sdogruyol sdogruyol sdogruyol approved these changes

@RX14 RX14 RX14 approved these changes

Assignees
No one assigned
Labels
kind:docs topic:infrastructure
Projects
None yet
Milestone
0.25.1
Development

Successfully merging this pull request may close these issues.

None yet
4 participants
@docelic @RX14 @sdogruyol @bcardiff