Skip to content

Backpack is undocumented #4761

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

Closed
23Skidoo opened this issue Sep 12, 2017 · 9 comments
Closed

Backpack is undocumented #4761

23Skidoo opened this issue Sep 12, 2017 · 9 comments

Comments

@23Skidoo
Copy link
Member

A user on Reddit brought to my attention that searching for "Backpack" in the user's guide returns zero results. It'd be nice if there was a Backpack section in the user's guide like we have for Nix integration, right now I have to refer people to posts on @ezyang's blog.

@ocharles
Copy link
Contributor

I'm quite surprised Backpack officially made it into 2.0 (to the point of receiving the blessing of being in the Changelog), yet made it there without any documentation. I do not mean this in a snarky way, but is there a release process behind releasing cabal-install, and if so - should this process not require that all new user facing features be documented? Also, I see this isn't scheduled for a milestone yet - should it be?

@ezyang
Copy link
Contributor

ezyang commented Sep 25, 2017

Hi @ocharles, the lack of documentation in the Cabal user manual was an oversight, due in part to the fact that the documentation is "elsewhere" (https://ghc.haskell.org/trac/ghc/wiki/Backpack ; the thesis contains a complete and accurate description of what Cabal supports). We definitely should add a Backpack section to the Cabal manual and it is one of my priorities.

@ocharles
Copy link
Contributor

Awesome, thanks @ezyang. I hope I didn't come across too negative, though my question about whether documentation is part of the release manager's checklist does still stand.

@phadej
Copy link
Collaborator

phadej commented Dec 13, 2017

@ezyang bump.

@23Skidoo
Copy link
Member Author

@ezyang, if you want to get this in before the next release, the branch-off date will be sometime around 15 Jan.

@sjakobi
Copy link
Member

sjakobi commented May 15, 2018

Bump! :)

@cartazio
Copy link
Contributor

@hvr @ezyang has there been more action on this?

@cartazio
Copy link
Contributor

cartazio commented Feb 4, 2020

bumpity bump bump :)

@ezyang
Copy link
Contributor

ezyang commented Feb 25, 2021

btw, Backpack is explicitly mentioned in the user guide now, but there is not a Backpack section which puts it together

ezyang added a commit that referenced this issue Feb 25, 2021
Fixes #4761

Signed-off-by: Edward Z. Yang <[email protected]>

[ghstack-poisoned]
ezyang added a commit that referenced this issue Feb 25, 2021
Fixes #4761

Signed-off-by: Edward Z. Yang <[email protected]>

ghstack-source-id: b220e55
Pull Request resolved: #7306
ezyang added a commit that referenced this issue Feb 28, 2021
Fixes #4761

Signed-off-by: Edward Z. Yang <[email protected]>

[ghstack-poisoned]
ezyang added a commit that referenced this issue Feb 28, 2021
Fixes #4761

Signed-off-by: Edward Z. Yang <[email protected]>

ghstack-source-id: 957ba1d
Pull Request resolved: #7306
@ezyang ezyang closed this as completed in 07d6890 Feb 28, 2021
hololeap pushed a commit to hololeap/cabal that referenced this issue Apr 24, 2022
Fixes haskell#4761

Signed-off-by: Edward Z. Yang <[email protected]>

ghstack-source-id: 957ba1d
Pull Request resolved: haskell#7306
hololeap pushed a commit to hololeap/cabal that referenced this issue Apr 24, 2022
Fixes haskell#4761

Signed-off-by: Edward Z. Yang <[email protected]>

ghstack-source-id: 957ba1d
Pull Request resolved: haskell#7306
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

6 participants