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 documentation on --config-file and CABAL_CONFIG env variable. #5859

Merged
merged 1 commit into from
Jan 24, 2019

Conversation

m-renaud
Copy link
Collaborator

@m-renaud m-renaud commented Jan 24, 2019

Add information about the --config-file command line flag and the CABAL_CONFIG environment variable for specifying the cabal config file to section 2.1 (Configuration) of the Cabal User Guide.

Fixes #5322.


Please include the following checklist in your PR:

  • Patches conform to the coding conventions.
  • Any changes that could be relevant to users have been recorded in the changelog.
  • The documentation has been updated, if necessary.
  • If the change is docs-only, [ci skip] is used to avoid triggering the build bots.

Please also shortly describe how you tested your change. Bonus points for added tests!

@m-renaud m-renaud changed the title Add documentation on --config-file and CONFIG_FILE env variable. Add documentation on --config-file and CABAL_CONFIG env variable. Jan 24, 2019
@hvr
Copy link
Member

hvr commented Jan 24, 2019

I wonder if it would make sense to create a special section in https://cabal.readthedocs.io/en/latest/cabal-projectindex.html for special CLI flags such as --config-file which don't fit into the existing sections.

@23Skidoo 23Skidoo merged commit 3b972bb into haskell:master Jan 24, 2019
@23Skidoo
Copy link
Member

Merged, thanks!

@23Skidoo
Copy link
Member

@hvr

I wonder if it would make sense to create a special section [...]

SGTM

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.

3 participants