Skip to content

Backport deprecation warnings to 2.2 #5378

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 6 commits into from
Jun 16, 2018

Conversation

typedrat
Copy link
Collaborator

@typedrat typedrat commented Jun 13, 2018

I was already working on this, but seeing @lspitzner's concerns in #5358 made me decide to wrap it up and make a PR.

To help ease the transition to 3.0 and the default new-build future, this backports the aliases and most importantly the warnings to ensure that people have time to update any scripts to use the aliases before the semantics would change.

Before this gets merged/released, if it does, I do want to come up with a list of all commands that need new- versions before 3.0 so that there will be all relevant warnings included.

--

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.

@typedrat typedrat added this to the 2.2 milestone Jun 13, 2018
@typedrat typedrat self-assigned this Jun 13, 2018
@typedrat typedrat requested a review from 23Skidoo June 13, 2018 19:10
@@ -1,5 +1,5 @@
name: Cabal
version: 2.2.0.1
version: 2.2.0.2
Copy link
Collaborator

Choose a reason for hiding this comment

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

why bump Cabal?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh, I see, added symbol. That should require third digit bump, patch (4th) level isn't enough.

@typedrat
Copy link
Collaborator Author

Seems to have an error in the travis script, but I'm not sure how that works.

@typedrat
Copy link
Collaborator Author

typedrat commented Jun 13, 2018

Commands that should also get warnings:

  • sdist
  • outdated
  • doctest
  • copy, register are likely not being replaced (based on my understanding, at least), but still
  • reconfigure
  • hscolour?

@23Skidoo
Copy link
Member

cabal hscolour will be killed in favour of Haddock's built-in colourising.

@typedrat
Copy link
Collaborator Author

I know, but not sure if that should come with a warning or not.

@23Skidoo
Copy link
Member

I've just merged a PR adding a warning to hscolour. Only to master though.

@typedrat
Copy link
Collaborator Author

Any that I'm not thinking of?

@23Skidoo
Copy link
Member

23Skidoo commented Jun 13, 2018

sandbox? It also will be eventually removed in favour of new-build.

@typedrat
Copy link
Collaborator Author

Okay, adding those. Should I also backport 6922cfc in this PR?

@23Skidoo
Copy link
Member

Please do.

@quasicomputational
Copy link
Contributor

If sdist and outdated are printing warnings, what should the warning message tell users to do instead? AFAIK we don't have new-style equivalents to those yet; until we have a concrete 'here's what you can do to future-proof your code and make this warning go away' suggestion, I don't believe they should warn.

@typedrat
Copy link
Collaborator Author

Without sdist install won't work, so it'll be there by the time it changes. outdated? IThere's #4831. And anyway, their suggested option is to switch to v1-sdist and v1-outdated, because the warning is only on the unprefixed versions.

@quasicomputational
Copy link
Contributor

There's still a nag for the v1- versions. On HEAD:

$ cabal new-run -v0 cabal -- v1-build --help
Compile all/specific components.

[...]

The v1-build command is a part of the legacy v1 style of cabal usage.

It is a legacy feature and will be removed in a future release of cabal-install.
Please file a bug if you cannot replicate a working v1- use case with the new-style
commands.

I could get behind the suggestion that sdist should warn but v1-sdist should be totally nag-free until new-sdist is in. I don't understand the interaction with install; if new-sdist is going to be implemented on the way then this works out, but I do think having a nag for things that don't have replacements will be the best way to get users to ignore the nagging and not upgrade in good time.

@typedrat
Copy link
Collaborator Author

Okay, I'll not give them to outdated since that's just a nebulously planned thing. new-sdist is required to implement new-install, so it's coming soon.

I mean, that warning is extremely not wrong and it only shows up in --help... I wonder if just wording it differently would work.

@typedrat typedrat force-pushed the backport-musical-chairs branch from f4b5fdd to c05f79c Compare June 14, 2018 21:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants