Skip to content

Add documentation for lock files#4602

Merged
snoyberg merged 3 commits intomasterfrom
lock-file-docs
Mar 6, 2019
Merged

Add documentation for lock files#4602
snoyberg merged 3 commits intomasterfrom
lock-file-docs

Conversation

@snoyberg
Copy link
Copy Markdown
Contributor

@snoyberg snoyberg commented Mar 4, 2019

Note: Documentation fixes for https://docs.haskellstack.org/en/stable/ should target the "stable" branch, not master.

Please include the following checklist in your PR:

  • Any changes that could be relevant to users have been recorded in the ChangeLog.md
  • The documentation has been updated, if necessary.

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

@snoyberg snoyberg requested review from psibi and qrilka March 4, 2019 08:26
Copy link
Copy Markdown
Contributor

@qrilka qrilka left a comment

Choose a reason for hiding this comment

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

Other than the couple of comments it looks OK to me

Comment thread doc/lock_files.md
Comment thread doc/lock_files.md Outdated
Comment thread doc/lock_files.md Outdated
Comment thread doc/lock_files.md
Comment thread doc/lock_files.md Outdated
Comment thread doc/lock_files.md
url: https://raw.githubusercontent.com/commercialhaskell/stackage-snapshots/master/lts/13/9.yaml
sha256: 83de9017d911cf7795f19353dba4d04bd24cd40622b7567ff61fc3f7223aa3ea

compiler: ghc-X.Y.Z
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

What about global ghc option ? Shouldn't it be also present ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

what do you mean by global here?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

@qrilka Probably global is the wrong word here. stack.yaml obtains ghc-option for the package. Should that option be present here in the lock file ?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

GHC options get applied per package, why do we need them here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

There may be one corner case we need to consider: ghc-options applied to all packages. However, I think that will be addressed by the approach described here.

@snoyberg snoyberg merged commit f2ac3e6 into master Mar 6, 2019
@snoyberg snoyberg deleted the lock-file-docs branch March 6, 2019 08:09
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