Skip to content

Quickstart guide refers to v2- commands #9086

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
tomjaguarpaw opened this issue Jul 5, 2023 · 6 comments · Fixed by #9087
Closed

Quickstart guide refers to v2- commands #9086

tomjaguarpaw opened this issue Jul 5, 2023 · 6 comments · Fixed by #9087

Comments

@tomjaguarpaw
Copy link
Member

Describe the bug

The Quickstart guide refers to v2- commands. v2- can be omitted (since at least cabal-install version 3) and I understand it's common practice to do so. Therefore I think the Quickstart guide should do so.

To Reproduce

Read The Quickstart guide. For example, it says $ cabal v2-build

Expected behavior

The Quickstart guide should say $ cabal build.

System information

A web browser.

Additional context

This issue confused a (potential) user in the real world.

I am willing to make the necessary edits if the cabal maintainers agree that this is indeed a bug.

@ulysses4ever
Copy link
Collaborator

@tomjaguarpaw my view is: absolutely, please go ahead with the PR. Unless someone more experienced raises a substantial concern, we'll merge it.

Previews stub at fixing docs w.r.t. v1-vs-v2 in the reference section of the manual:

The page you're reporting has been reported before:

A more generic discussion on the topic:

@tomjaguarpaw
Copy link
Member Author

Thanks, I submitted #9087

@geekosaur
Copy link
Collaborator

While people are thinking about this, when I recently submitted a cabal bug the reporting template told me to explicitly use v2- commands for clarity. This should probably change as well.

@ulysses4ever
Copy link
Collaborator

@geekosaur by all means. I added a checkbox in #8511 Contributions are welcome!

@seanhess
Copy link

seanhess commented Jul 6, 2023

I'm the "user in the wild" mentioned in the bug report. I just ran into the same thing that @geekosaur said:

➜ cabal update
Downloading the latest package list from hackage.haskell.org
Updated package list of hackage.haskell.org to the index-state 2023-07-06T14:48:07Z
To revert to previous state run:
    cabal v2-update 'hackage.haskell.org,2022-11-02T09:30:00Z'

I assume that I can drop the v2 prefix?

@ulysses4ever
Copy link
Collaborator

@seanhess yes, you can. Perhaps, you'd like to submit a patch removing v2 from there? It's one grep and one change away, I'm sure.

tomjaguarpaw added a commit to tomjaguarpaw/cabal that referenced this issue Jul 6, 2023
ulysses4ever pushed a commit to tomjaguarpaw/cabal that referenced this issue Jul 9, 2023
@mergify mergify bot closed this as completed in #9087 Jul 9, 2023
mergify bot pushed a commit that referenced this issue Jul 14, 2023
Closes #9086

(cherry picked from commit b3953e3)
ulysses4ever added a commit that referenced this issue Jul 14, 2023
Remove v2-prefix from Quickstart guide

Closes #9086

(cherry picked from commit b3953e3)

* Clarify what build is

Co-authored-by: Artem Pelenitsyn <[email protected]>
(cherry picked from commit 1f5c00d)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants