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

Avoid double space in "Executing install plan ..." #9376

Conversation

philderbeast
Copy link
Collaborator

@philderbeast philderbeast commented Oct 28, 2023

This PR does not modify cabal behaviour1

Include the following checklist in your PR:

$ cabal run cabal-testsuite:cabal-tests -- \
   --with-cabal=./dist-newstyle/build/x86_64-linux/ghc-9.2.7/cabal-install-3.11.0.0/x/cabal/build/cabal/cabal cabal-testsuite/PackageTests/LinkerOptions/NonignoredConfigs/cabal.test.hs
...
  -----BEGIN CABAL OUTPUT-----
  Build profile: -w ghc-9.2.7 -O1
  In order, the following will be built:
   - basic-0.1 (lib) (requires build)
  -----END CABAL OUTPUT-----
-  Executing install plan  serially.
+  Executing install plan serially.

Scratch that. This PR modifies cabal behaviour.

Bonus points for added automated tests!

Footnotes

  1. A double space in a message is reduced to a single space:

@philderbeast
Copy link
Collaborator Author

I'm not sure how to test this since the output is outside a CABAL OUTPUT block.

Copy link
Collaborator

@ffaf1 ffaf1 left a comment

Choose a reason for hiding this comment

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

Actually it does modify cabal behaviour.

@ulysses4ever
Copy link
Collaborator

It absolutely does.

@philderbeast
Copy link
Collaborator Author

Actually it does modify cabal behaviour.

Given the choice between the two pull request templates, deduplicating whitespace seemed to me to be closer to the no change end of the spectrum.

@geekosaur
Copy link
Collaborator

It is nevertheless user-visible behavior, and may be relied upon by e.g. test suites which compare output.

@ulysses4ever
Copy link
Collaborator

@philderbeast just to be clear, no one tries to put blame on you for choosing the wrong template. The blame is all on us who phrased the templates in the current form, which, as you mention, opens the door for interpretations. We'd welcome patches improving the templates. I currently don't have a good idea how to improve them.

@philderbeast
Copy link
Collaborator Author

I've added a changelog entry.

@philderbeast
Copy link
Collaborator Author

@ulysses4ever I hope that is OK to add the "merge+no rebase" label now myself.

@ulysses4ever
Copy link
Collaborator

@philderbeast I think so, yes. Thank you!

@mergify mergify bot added the merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days label Nov 1, 2023
@mergify mergify bot merged commit d644b79 into haskell:master Nov 1, 2023
42 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
merge delay passed Applied (usually by Mergify) when PR approved and received no updates for 2 days merge+no rebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants