docs: Add build-essential to Prerequisites (#1595)#1691
Merged
josecelano merged 1 commit intotorrust:developfrom Apr 16, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## develop #1691 +/- ##
========================================
Coverage 86.50% 86.50%
========================================
Files 288 288
Lines 22672 22672
Branches 22672 22672
========================================
Hits 19613 19613
Misses 2833 2833
Partials 226 226 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
josecelano
added a commit
to josecelano/torrust-tracker
that referenced
this pull request
Apr 16, 2026
…st#1595) 8b7fa32 docs(torrust#1595): Add build-essential to Prerequisites (Jose Celano) Pull request description: ## Description Resolves torrust#1595 ### Changes Added `build-essential` package to the Prerequisites section of the documentation. This package is required to provide the C compiler (`cc`) which is essential for compiling Rust code and its dependencies. ### Why When building on a fresh Ubuntu 24 machine, users encountered the error: ``` error: linker `cc` not found ``` This error occurs because `build-essential` (which includes the C compiler) was not installed. The documentation did not mention this requirement, so users had to discover it through trial and error. ### What Changed - Added a new prerequisite step to install `build-essential` before other dependencies - This ensures users have the necessary build tools before attempting to compile the project ### Documentation The change is reflected in the Rust documentation under the "Prerequisites" section which is published to [docs.rs](https://docs.rs/torrust-tracker/latest/torrust_tracker/#prerequisites). ACKs for top commit: josecelano: ACK 8b7fa32 Tree-SHA512: 8c0605623a8d92b1208252a41d5b9a4df5cdfafb7f3efaeb9658aed3958c0a34538298f2f4908a7efd4858d830ab0d6760f6d63a9bafe0ccad3cef5646a20d6b
The build-essential package is required to provide the C compiler (cc) needed for compilation. This was missing from the prerequisites documentation. Closes torrust#1595
josecelano
force-pushed
the
docs/1595-add-build-essential-requirement
branch
from
3eddacc to
92929ba
Compare
Member
Author
|
ACK 92929ba |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Resolves #1595
Changes
Added
build-essentialpackage to the Prerequisites section of the documentation. This package is required to provide the C compiler (cc) which is essential for compiling Rust code and its dependencies.Why
When building on a fresh Ubuntu 24 machine, users encountered the error:
This error occurs because
build-essential(which includes the C compiler) was not installed. The documentation did not mention this requirement, so users had to discover it through trial and error.What Changed
build-essentialbefore other dependenciesDocumentation
The change is reflected in the Rust documentation under the "Prerequisites" section which is published to docs.rs.