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

Documentation unclear about requirements / build.sh no good perceptible warnings / errors #3747

Closed
raypatterson77 opened this issue Feb 28, 2022 · 1 comment
Labels
spec-bug Something which is in the spec, but is wrong

Comments

@raypatterson77
Copy link

Link to problem area: https://github.com/matrix-org/dendrite/blob/main/docs/INSTALL.md

Issue
#Documentation is unclear about requirements

  • Requirements are missing git and gcc
  • For git it is very trivial to be a requirement due to cloning the repository
  • But without gcc the build.sh script is not failing or displaying good perceptible warnings / errors.
  • On a fresh installed Debian 11 (5.10.0-11-amd64) I was able to run the build.sh but had no generate-keys nor dendrite-monolith-server in the bin folder.
  • Running:
go build -o bin/generate-keys ./cmd/generate-keys
  • gave me the error, that no gcc was found in $PATH
  • after installing gcc:
gcc --version
gcc (Debian 10.2.1-6) 10.2.1 20210110
[...]
  • and clone a new repository, running build.sh works as expected
  • Unfortunately I not examine the gcc problem further, but as said, it was a fresh installation of Debian 11 <
/usr/bin
  • was definitly in $PATH

Expected behavior

  • requirements should be clearer in documentation or the build.sh script should give more perceptible warnings / errors

If this is not wanted for a particular reason I can create a pull request and add git and gcc to the requirements but I'm not sure about the miniumum versions

@raypatterson77 raypatterson77 added the spec-bug Something which is in the spec, but is wrong label Feb 28, 2022
@raypatterson77 raypatterson77 changed the title Documentation unclead about requirements / build.sh no good perceptible warnings / errors Documentation unclear about requirements / build.sh no good perceptible warnings / errors Feb 28, 2022
@raypatterson77
Copy link
Author

Sorry, opend the issue in the wrong place - closed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
spec-bug Something which is in the spec, but is wrong
Projects
None yet
Development

No branches or pull requests

1 participant