Skip to content

Warn about packages default value in docs #8300

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

Merged
merged 4 commits into from
Jul 20, 2022

Conversation

jneira
Copy link
Member

@jneira jneira commented Jul 18, 2022


Please include the following checklist in your PR:

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

@jneira jneira changed the title Warn about packages default value Warn about packages default value in docs Jul 18, 2022
Copy link
Collaborator

@ulysses4ever ulysses4ever left a comment

Choose a reason for hiding this comment

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

Clear improvement, thank you!

one thing I can’t stop thinking about though is why not change the implementation such that the old docs were true, meaning not require packages. The default value makes a lot of sense, so why not use it even if cabal.project is present.

@jneira
Copy link
Member Author

jneira commented Jul 18, 2022

Yeah, in the issue the empty default value when project file is present was defended but there are no concrete arguments.
Thinking twice about the warning i am afraid that maybe is not 100% precise: you could not fill the packages field but optional-packages and I guess cabal will be happy if an optional package is present.

Weird semantics, if you would ask me.

@ulysses4ever
Copy link
Collaborator

This probably should be backported…

Is there a [skip ci] policy on Cabal repository? I always forget to put personally, but it can speed up the merge tremendously. Also, Not sure if Mergify supports it out of the box. GitHub itself does.

@Mikolaj
Copy link
Member

Mikolaj commented Jul 19, 2022

@mergify backport 3.8

@mergify
Copy link
Contributor

mergify bot commented Jul 19, 2022

backport 3.8

🟠 Waiting for conditions to match

  • merged [:pushpin: backport requirement]

@Mikolaj
Copy link
Member

Mikolaj commented Jul 19, 2022

That's a lot of approvals. Shall we merge?

@Mikolaj
Copy link
Member

Mikolaj commented Jul 20, 2022

@jneira is busy, so let me trigger the process.

@Mikolaj Mikolaj added the squash+merge me Tell Mergify Bot to squash-merge label Jul 20, 2022
@Mikolaj
Copy link
Member

Mikolaj commented Jul 20, 2022

@mergify backport 3.8

@mergify
Copy link
Contributor

mergify bot commented Jul 20, 2022

backport 3.8

🟠 Waiting for conditions to match

  • merged [:pushpin: backport requirement]

@mergify mergify bot merged commit 180b671 into master Jul 20, 2022
mergify bot added a commit that referenced this pull request Jul 20, 2022
* Warn about packages default value

* Use double backquotes

* Syntax correction

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
(cherry picked from commit 180b671)
@mergify
Copy link
Contributor

mergify bot commented Jul 20, 2022

backport 3.8

✅ Backports have been created

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation squash+merge me Tell Mergify Bot to squash-merge
Projects
None yet
Development

Successfully merging this pull request may close these issues.

cabal cannot find cabal.project or *.cabal unless packages is defined
4 participants