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

Cardano Node Installation process: add cabal update #1150

Merged
merged 4 commits into from
Dec 4, 2023

Conversation

schmidko
Copy link
Contributor

@schmidko schmidko commented Sep 25, 2023

Checklist

  • I have read the How to Contribute.
  • I have run yarn build after adding my changes without getting any errors.

Updating documentation or Bugfix

The documentation regarding the installation of the Cardano node could benefit from a minor update. Specifically, there is a crucial step missing: running "cabal update" before executing the "cabal configure --with-compiler=ghc-8.10.7" command. It's easy for users to miss the warning and this leading to confusion when the node build doesn't proceed as expected.

cabal configure fails without an update
@rphair rphair changed the title Add documentation for an "cabal update" Cardano Node Installation process: add cabal update Sep 27, 2023
@rphair rphair added the documentation Improvements or additions to documentation label Sep 27, 2023
Copy link
Collaborator

@rphair rphair left a comment

Choose a reason for hiding this comment

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

Already added to docs/get-started/installing-cardano-node.md in #1008 but for some reason got missed in this page (it might still have been in the development branch at the time).

@rdlrt @os11k I would normally do cabal update immediately before cabal build but maybe it's better the way it's presented here, e.g. if people are using more than one version of GHC (personally I don't, so haven't investigated). 🤔

@rdlrt
Copy link
Collaborator

rdlrt commented Sep 27, 2023

Already added to docs/get-started/installing-cardano-node.md in #1008 but for some reason got missed in this page (it might still have been in the development branch at the time).

@rdlrt @os11k I would normally do cabal update immediately before cabal build but maybe it's better the way it's presented here, e.g. if people are using more than one version of GHC (personally I don't, so haven't investigated). 🤔

I'd imagine configure will be (more often than not) a once-off...and should always occur prior to cabal update , I'd also go with executing it right before build.

@katomm katomm merged commit d8b24c4 into cardano-foundation:staging Dec 4, 2023
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants