Skip to content

Commit d178b2b

Browse files
committed
Merge #1691: docs: Add build-essential to Prerequisites (#1595)
92929ba docs(#1595): Add build-essential to Prerequisites (Jose Celano) Pull request description: ## Description Resolves #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 92929ba Tree-SHA512: 8c0605623a8d92b1208252a41d5b9a4df5cdfafb7f3efaeb9658aed3958c0a34538298f2f4908a7efd4858d830ab0d6760f6d63a9bafe0ccad3cef5646a20d6b
2 parents ef5be41 + 92929ba commit d178b2b

File tree

1 file changed

+6
-0
lines changed

1 file changed

+6
-0
lines changed

src/lib.rs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,12 @@
8888
//!
8989
//! The tracker has some system dependencies:
9090
//!
91+
//! First, you need to install the build tools:
92+
//!
93+
//! ```text
94+
//! sudo apt-get install build-essential
95+
//! ```
96+
//!
9197
//! Since we are using the `openssl` crate with the [vendored feature](https://docs.rs/openssl/latest/openssl/#vendored),
9298
//! enabled, you will need to install the following dependencies:
9399
//!

0 commit comments

Comments
 (0)