Skip to content
This repository has been archived by the owner on Aug 2, 2020. It is now read-only.

Improve documentation for cross compilation #513

Open
chitrak7 opened this issue Feb 25, 2018 · 4 comments
Open

Improve documentation for cross compilation #513

chitrak7 opened this issue Feb 25, 2018 · 4 comments

Comments

@chitrak7
Copy link
Contributor

In the documentation for building cross-compiling GHC, the steps mentioned are :
git clone https://github.com/ghc/ghc
cd ghc
git clone https://github.com/snowleopard/hadrian

this step will result in an error at multiple sub-repositories with the error similar this :
fatal: repository 'https://github.com/ghc/packages/deepseq.git/' not found.

It is because of GitHub's policy to not include '/' in names. This can be easily removed by the following command.
git config --global url."https://github.com/ghc/packages-".insteadOf https://github.com/ghc/packages/

I think this should be included in the documentation.

@snowleopard
Also, if this change is approved, can I put the PR myself?

@snowleopard
Copy link
Owner

snowleopard commented Feb 25, 2018

@chitrak7 Yes, sure, go ahead! Documentation improvements are very welcome. Please coordinate with @angerman and @izgzhen who are taking care of cross compilation. I myself will not be able to properly review the suggested changes, since I've never done cross compilation.

Also note that @angerman and @alpmestan are working on a huge PR that improves cross compilation: #445. We hope to merge this PR soon, so some things may be changing soon.

@snowleopard snowleopard changed the title Possible improvement in documentation of cross-compile Improve documentation for cross compilation Feb 25, 2018
@izgzhen
Copy link
Collaborator

izgzhen commented Feb 27, 2018

this step will result in an error at multiple sub-repositories with the error similar this :
fatal: repository 'https://github.com/ghc/packages/deepseq.git/' not found.

BTW, I tried the newest source today, and met some problems finding submodule like Cabal. I fixed it by cloning from haskell.org instead of github.

@angerman
Copy link
Collaborator

I would strongly suggest removing any mention of cloning GHC from github.

@izgzhen
Copy link
Collaborator

izgzhen commented Feb 27, 2018

I would strongly suggest removing any mention of cloning GHC from github.

Agreed

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants