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

Better Documentation for Clash Flags #951

Closed
alex-mckenna opened this issue Dec 2, 2019 · 1 comment · Fixed by #987
Closed

Better Documentation for Clash Flags #951

alex-mckenna opened this issue Dec 2, 2019 · 1 comment · Fixed by #987
Labels
documentation enhancement papercut Small quality-of-life issues

Comments

@alex-mckenna
Copy link
Contributor

As mentioned in the comments GH-949, there is currently no proper documentation for clash and clashi specific flags. These should be included somewhere which is easy to find, and clearly explains what the purpose and default values of different flags are.

On a related note, running clash --show-options currently does not show any clash specific options (e.g. anything starting with -fclash-OPT currently isn't printed. This also makes it more difficult for users to know what clash-specific flags are available.
@alex-mckenna alex-mckenna added enhancement papercut Small quality-of-life issues documentation labels Dec 2, 2019
@alex-mckenna alex-mckenna mentioned this issue Dec 3, 2019
Open
@alex-mckenna
Copy link
Contributor Author

Update: With regards to clash --show-options not showing all options, it appears that the list of flags to print in the GHC specific modules do not include the common flags from Clash.GHC.ClashFlags.

alex-mckenna pushed a commit that referenced this issue Dec 9, 2019
Print common Clash flags in --show-options (#951)
cde7c26 
When calling clash with the --show-options flag, it now prints
all options, including common clash options which were previously
not being shown. It remains to be seen how to document all the flags
which are added by clash (instead of GHC).
@alex-mckenna alex-mckenna mentioned this issue Dec 9, 2019
Merged
@alex-mckenna alex-mckenna mentioned this issue Jan 8, 2020
Merged
5 tasks
leonschoorl pushed a commit that referenced this issue Jan 13, 2020
@leonschoorl
Print common Clash flags in --show-options (#951)
584eae5 
When calling clash with the --show-options flag, it now prints
all options, including common clash options which were previously
not being shown. It remains to be seen how to document all the flags
which are added by clash (instead of GHC).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation enhancement papercut Small quality-of-life issues
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Restructure and Update Documentation clash-lang/clash-compiler
1 participant
@alex-mckenna