Skip to content

Commit a460116

Browse files
authored
Change rustdoc docs to only compile+run in release mode
As-is, it asks the user to do a release mode build first, then after creating the directories, then do a debug mode build + run. This commit simplifies it and avoids compiling the tracker in both debug and release mode, and instead only compiles+run with release mode
1 parent 326e577 commit a460116

1 file changed

Lines changed: 1 addition & 2 deletions

File tree

src/lib.rs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,6 @@
138138
//! ```text
139139
//! git clone https://github.com/torrust/torrust-tracker.git \
140140
//! && cd torrust-tracker \
141-
//! && cargo build --release \
142141
//! && mkdir -p ./storage/tracker/etc \
143142
//! && mkdir -p ./storage/tracker/lib/database \
144143
//! && mkdir -p ./storage/tracker/lib/tls \
@@ -149,7 +148,7 @@
149148
//! compile and after being compiled it will start running the tracker.
150149
//!
151150
//! ```text
152-
//! cargo run
151+
//! cargo run --release
153152
//! ```
154153
//!
155154
//! ## Run with docker

0 commit comments

Comments
 (0)