From 3045e0ac63fd5c4e2e543649c6871d896cbf9c0b Mon Sep 17 00:00:00 2001 From: Sergio Benitez Date: Sat, 27 Mar 2021 14:20:43 -0700 Subject: [PATCH] Add doc notes on how to depend on '-dev' versions. --- core/lib/src/lib.rs | 9 +++++++-- site/guide/2-getting-started.md | 13 +++++++++++++ 2 files changed, 20 insertions(+), 2 deletions(-) diff --git a/core/lib/src/lib.rs b/core/lib/src/lib.rs index 937b531d..9d37ed49 100644 --- a/core/lib/src/lib.rs +++ b/core/lib/src/lib.rs @@ -43,8 +43,13 @@ //! rocket = "0.5.0-dev" //! ``` //! -//! See the [guide](https://rocket.rs/master/guide) for more information on how to -//! write Rocket applications. Here's a simple example to get you started: +//! Note that development versions, tagged with `-dev`, are not published +//! and will will need to be specified as [git dependencies]. +//! +//! See the [guide](https://rocket.rs/master/guide) for more information on how +//! to write Rocket applications. Here's a simple example to get you started: +//! +//! [git dependencies]: https://doc.rust-lang.org/cargo/reference/specifying-dependencies.html#specifying-dependencies-from-git-repositories //! //! ```rust,no_run //! #[macro_use] extern crate rocket; diff --git a/site/guide/2-getting-started.md b/site/guide/2-getting-started.md index a33f109e..60528e63 100644 --- a/site/guide/2-getting-started.md +++ b/site/guide/2-getting-started.md @@ -46,6 +46,19 @@ Now, add Rocket as a dependency in your `Cargo.toml`: rocket = "0.5.0-dev" ``` +! warning: Development versions must be _git_ dependencies. + + Development versions, tagged with `-dev`, are not published. To depend on a + development version of Rocket, you'll need to point `Cargo.toml` to a Rocket + git repository. For example, with `######` replaced with a git commit hash: + + ` + [dependencies] + ` + ` + rocket = { git = "https://github.com/SergioBenitez/Rocket", rev = "######" } + ` + Modify `src/main.rs` so that it contains the code for the Rocket `Hello, world!` program, reproduced below: