diff --git a/CHANGELOG.md b/CHANGELOG.md index ecd03265..a7fc4782 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -278,7 +278,7 @@ This release includes the following new features: * [`Response::content_type()`] was added to easily retrieve the Content-Type header of a response. * Size limits on incoming data are [now - configurable](https://rocket.rs/guide/configuration/#data-limits). + configurable](https://rocket.rs/v0.3/guide/configuration/#data-limits). * [`Request::limits()`] was added to retrieve incoming data limits. * Responders may dynamically adjust their response based on the incoming request. @@ -302,31 +302,31 @@ This release includes the following new features: * The [`NotFound`] responder was added for simple **404** response construction. -[Fairings]: https://rocket.rs/guide/fairings/ -[Native TLS support]: https://rocket.rs/guide/configuration/#configuring-tls -[Private cookies]: https://rocket.rs/guide/requests/#private-cookies -[can be renamed]: https://rocket.rs/guide/requests/#field-renaming -[`MsgPack`]: https://api.rocket.rs/rocket_contrib/struct.MsgPack.html -[`Rocket::launch()`]: https://api.rocket.rs/rocket/struct.Rocket.html#method.launch -[`LaunchError`]: https://api.rocket.rs/rocket/error/struct.LaunchError.html -[Default rankings]: https://api.rocket.rs/rocket/struct.Route.html -[`Route`]: https://api.rocket.rs/rocket/struct.Route.html -[`Accept`]: https://api.rocket.rs/rocket/http/struct.Accept.html -[`Request::accept()`]: https://api.rocket.rs/rocket/struct.Request.html#method.accept -[`contrib`]: https://api.rocket.rs/rocket_contrib/ -[`Rocket::routes()`]: https://api.rocket.rs/rocket/struct.Rocket.html#method.routes -[`Response::body_string()`]: https://api.rocket.rs/rocket/struct.Response.html#method.body_string -[`Response::body_bytes()`]: https://api.rocket.rs/rocket/struct.Response.html#method.body_bytes -[`Response::content_type()`]: https://api.rocket.rs/rocket/struct.Response.html#method.content_type -[`Request::guard()`]: https://api.rocket.rs/rocket/struct.Request.html#method.guard -[`Request::limits()`]: https://api.rocket.rs/rocket/struct.Request.html#method.limits -[`Request::route()`]: https://api.rocket.rs/rocket/struct.Request.html#method.route -[`Config`]: https://api.rocket.rs/rocket/struct.Config.html -[`Cookies`]: https://api.rocket.rs/rocket/http/enum.Cookies.html -[`Config::get_datetime()`]: https://api.rocket.rs/rocket/struct.Config.html#method.get_datetime -[`LenientForm`]: https://api.rocket.rs/rocket/request/struct.LenientForm.html -[configuration parameters]: https://api.rocket.rs/rocket/config/index.html#environment-variables -[`NotFound`]: https://api.rocket.rs/rocket/response/status/struct.NotFound.html +[Fairings]: https://rocket.rs/v0.3/guide/fairings/ +[Native TLS support]: https://rocket.rs/v0.3/guide/configuration/#configuring-tls +[Private cookies]: https://rocket.rs/v0.3/guide/requests/#private-cookies +[can be renamed]: https://rocket.rs/v0.3/guide/requests/#field-renaming +[`MsgPack`]: https://api.rocket.rs/v0.3/rocket_contrib/struct.MsgPack.html +[`Rocket::launch()`]: https://api.rocket.rs/v0.3/rocket/struct.Rocket.html#method.launch +[`LaunchError`]: https://api.rocket.rs/v0.3/rocket/error/struct.LaunchError.html +[Default rankings]: https://api.rocket.rs/v0.3/rocket/struct.Route.html +[`Route`]: https://api.rocket.rs/v0.3/rocket/struct.Route.html +[`Accept`]: https://api.rocket.rs/v0.3/rocket/http/struct.Accept.html +[`Request::accept()`]: https://api.rocket.rs/v0.3/rocket/struct.Request.html#method.accept +[`contrib`]: https://api.rocket.rs/v0.3/rocket_contrib/ +[`Rocket::routes()`]: https://api.rocket.rs/v0.3/rocket/struct.Rocket.html#method.routes +[`Response::body_string()`]: https://api.rocket.rs/v0.3/rocket/struct.Response.html#method.body_string +[`Response::body_bytes()`]: https://api.rocket.rs/v0.3/rocket/struct.Response.html#method.body_bytes +[`Response::content_type()`]: https://api.rocket.rs/v0.3/rocket/struct.Response.html#method.content_type +[`Request::guard()`]: https://api.rocket.rs/v0.3/rocket/struct.Request.html#method.guard +[`Request::limits()`]: https://api.rocket.rs/v0.3/rocket/struct.Request.html#method.limits +[`Request::route()`]: https://api.rocket.rs/v0.3/rocket/struct.Request.html#method.route +[`Config`]: https://api.rocket.rs/v0.3/rocket/struct.Config.html +[`Cookies`]: https://api.rocket.rs/v0.3/rocket/http/enum.Cookies.html +[`Config::get_datetime()`]: https://api.rocket.rs/v0.3/rocket/struct.Config.html#method.get_datetime +[`LenientForm`]: https://api.rocket.rs/v0.3/rocket/request/struct.LenientForm.html +[configuration parameters]: https://api.rocket.rs/v0.3/rocket/config/index.html#environment-variables +[`NotFound`]: https://api.rocket.rs/v0.3/rocket/response/status/struct.NotFound.html ## Breaking Changes @@ -462,18 +462,18 @@ applications. Use `Json`, `Xml`, `Html`, and `Css` instead of `JSON`, `XML`, `HTML`, and `CSS`, respectively. -[`&RawStr`]: https://api.rocket.rs/rocket/http/struct.RawStr.html -[`IntoOutcome`]: https://api.rocket.rs/rocket/outcome/trait.IntoOutcome.html -[`local`]: https://api.rocket.rs/rocket/local/index.html -[`Rocket::config()`]: https://api.rocket.rs/rocket/struct.Rocket.html#method.config -[managed state]: https://rocket.rs/guide/state/ -[`Responder`]: https://api.rocket.rs/rocket/response/trait.Responder.html -[`Template::show()`]: https://api.rocket.rs/rocket_contrib/struct.Template.html#method.show -[`FromForm`]: https://api.rocket.rs/rocket/request/trait.FromForm.html -[`ConfigError`]: https://api.rocket.rs/rocket/config/enum.ConfigError.html -[`ContentType::from_extension()`]: https://api.rocket.rs/rocket/http/struct.ContentType.html#method.from_extension -[`rocket_contrib::Json`]: https://api.rocket.rs/rocket_contrib/struct.Json.html -[`content`]: https://api.rocket.rs/rocket/response/content/index.html +[`&RawStr`]: https://api.rocket.rs/v0.3/rocket/http/struct.RawStr.html +[`IntoOutcome`]: https://api.rocket.rs/v0.3/rocket/outcome/trait.IntoOutcome.html +[`local`]: https://api.rocket.rs/v0.3/rocket/local/index.html +[`Rocket::config()`]: https://api.rocket.rs/v0.3/rocket/struct.Rocket.html#method.config +[managed state]: https://rocket.rs/v0.3/guide/state/ +[`Responder`]: https://api.rocket.rs/v0.3/rocket/response/trait.Responder.html +[`Template::show()`]: https://api.rocket.rs/v0.3/rocket_contrib/struct.Template.html#method.show +[`FromForm`]: https://api.rocket.rs/v0.3/rocket/request/trait.FromForm.html +[`ConfigError`]: https://api.rocket.rs/v0.3/rocket/config/enum.ConfigError.html +[`ContentType::from_extension()`]: https://api.rocket.rs/v0.3/rocket/http/struct.ContentType.html#method.from_extension +[`rocket_contrib::Json`]: https://api.rocket.rs/v0.3/rocket_contrib/struct.Json.html +[`content`]: https://api.rocket.rs/v0.3/rocket/response/content/index.html ## General Improvements @@ -500,8 +500,8 @@ In addition to new features, Rocket saw the following improvements: * The format of a request is always logged when available. [`yansi`]: https://crates.io/crates/yansi -[`Request`]: https://api.rocket.rs/rocket/struct.Request.html -[`State`]: https://api.rocket.rs/rocket/struct.State.html +[`Request`]: https://api.rocket.rs/v0.3/rocket/struct.Request.html +[`State`]: https://api.rocket.rs/v0.3/rocket/struct.State.html ## Infrastructure @@ -606,7 +606,7 @@ In addition to new features, Rocket saw the following improvements: # Version 0.2.0 (Feb 06, 2017) Detailed release notes for v0.2 can also be found on -[rocket.rs](https://rocket.rs/news/2017-02-06-version-0.2/). +[rocket.rs](https://rocket.rs/v0.3/news/2017-02-06-version-0.2/). ## New Features diff --git a/README.md b/README.md index d6373f25..fdd52f59 100644 --- a/README.md +++ b/README.md @@ -39,11 +39,11 @@ Rocket is extensively documented: * [Guide]: A detailed guide and reference to Rocket. * [API Documentation]: The "rustdocs". -[Quickstart]: https://rocket.rs/guide/quickstart -[Getting Started]: https://rocket.rs/guide/getting-started -[Overview]: https://rocket.rs/overview -[Guide]: https://rocket.rs/guide -[API Documentation]: https://api.rocket.rs/rocket +[Quickstart]: https://rocket.rs/v0.4/guide/quickstart +[Getting Started]: https://rocket.rs/v0.4/guide/getting-started +[Overview]: https://rocket.rs/v0.4/overview +[Guide]: https://rocket.rs/v0.4/guide +[API Documentation]: https://api.rocket.rs/v0.4/rocket The official community support channels are the `#rocket` IRC channel on the [Mozilla IRC Server](https://wiki.mozilla.org/IRC) at `irc.mozilla.org` and the @@ -111,7 +111,7 @@ for information on how to write compiler tests. You can build the Rocket API documentation locally by running `./scripts/mk-docs.sh`. The resulting documentation is what gets uploaded to -[api.rocket.rs](https://api.rocket.rs). +[api.rocket.rs](https://api.rocket.rs/v0.4/). ## Contributing diff --git a/contrib/codegen/Cargo.toml b/contrib/codegen/Cargo.toml index 229b2a3e..6fc96e42 100644 --- a/contrib/codegen/Cargo.toml +++ b/contrib/codegen/Cargo.toml @@ -3,7 +3,7 @@ name = "rocket_contrib_codegen" version = "0.4.0-dev" authors = ["Sergio Benitez "] description = "Procedural macros for the Rocket contrib libraries." -documentation = "https://api.rocket.rs/rocket_contrib_codegen/" +documentation = "https://api.rocket.rs/v0.4/rocket_contrib_codegen/" homepage = "https://rocket.rs" repository = "https://github.com/SergioBenitez/Rocket" readme = "../../../README.md" diff --git a/contrib/lib/Cargo.toml b/contrib/lib/Cargo.toml index 657d8df8..1a24706c 100644 --- a/contrib/lib/Cargo.toml +++ b/contrib/lib/Cargo.toml @@ -3,7 +3,7 @@ name = "rocket_contrib" version = "0.4.0-dev" authors = ["Sergio Benitez "] description = "Community contributed libraries for the Rocket web framework." -documentation = "https://api.rocket.rs/0.4.0-dev/rocket_contrib/" +documentation = "https://api.rocket.rs/v0.4/rocket_contrib/" homepage = "https://rocket.rs" repository = "https://github.com/SergioBenitez/Rocket" readme = "../../README.md" diff --git a/contrib/lib/src/databases.rs b/contrib/lib/src/databases.rs index 9e9f85bd..16c3a6de 100644 --- a/contrib/lib/src/databases.rs +++ b/contrib/lib/src/databases.rs @@ -174,7 +174,7 @@ //! Lastly, databases can be configured via environment variables by specifying //! the `databases` table as detailed in the [Environment Variables //! configuration -//! guide](https://rocket.rs/guide/configuration/#environment-variables): +//! guide](https://rocket.rs/v0.4/guide/configuration/#environment-variables): //! //! ```bash //! ROCKET_DATABASES={my_db={url="db.sqlite"}} diff --git a/contrib/lib/src/lib.rs b/contrib/lib/src/lib.rs index 754998b0..44ab03a5 100644 --- a/contrib/lib/src/lib.rs +++ b/contrib/lib/src/lib.rs @@ -2,9 +2,9 @@ #![feature(never_type)] #![feature(doc_cfg)] -#![doc(html_root_url = "https://api.rocket.rs/0.4.0-dev")] -#![doc(html_favicon_url = "https://rocket.rs/favicon.ico")] -#![doc(html_logo_url = "https://rocket.rs/images/logo-boxed.png")] +#![doc(html_root_url = "https://api.rocket.rs/v0.4")] +#![doc(html_favicon_url = "https://rocket.rs/v0.4/images/favicon.ico")] +#![doc(html_logo_url = "https://rocket.rs/v0.4/images/logo-boxed.png")] //! This crate contains officially sanctioned contributor libraries that provide //! functionality commonly used by Rocket applications. diff --git a/contrib/lib/src/templates/mod.rs b/contrib/lib/src/templates/mod.rs index dd4bf86c..55435687 100644 --- a/contrib/lib/src/templates/mod.rs +++ b/contrib/lib/src/templates/mod.rs @@ -57,8 +57,8 @@ //! template directory is configured via the `template_dir` configuration //! parameter and defaults to `templates/`. The path set in `template_dir` is //! relative to the Rocket configuration file. See the [configuration -//! chapter](https://rocket.rs/guide/configuration/#extras) of the guide for -//! more information on configuration. +//! chapter](https://rocket.rs/v0.4/guide/configuration/#extras) of the guide +//! for more information on configuration. //! //! The corresponding templating engine used for a given template is based on a //! template's extension. At present, this library supports the following diff --git a/core/codegen/Cargo.toml b/core/codegen/Cargo.toml index b7bc15b6..915b0a70 100644 --- a/core/codegen/Cargo.toml +++ b/core/codegen/Cargo.toml @@ -3,7 +3,7 @@ name = "rocket_codegen" version = "0.4.0-dev" authors = ["Sergio Benitez "] description = "Procedural macros for the Rocket web framework." -documentation = "https://api.rocket.rs/0.4.0-dev/rocket_codegen/" +documentation = "https://api.rocket.rs/v0.4/rocket_codegen/" homepage = "https://rocket.rs" repository = "https://github.com/SergioBenitez/Rocket" readme = "../../README.md" diff --git a/core/codegen/src/lib.rs b/core/codegen/src/lib.rs index e5728241..cc4592a4 100644 --- a/core/codegen/src/lib.rs +++ b/core/codegen/src/lib.rs @@ -4,16 +4,16 @@ #![feature(rustc_private)] #![recursion_limit="128"] -#![doc(html_root_url = "https://api.rocket.rs/0.4.0-dev")] -#![doc(html_favicon_url = "https://rocket.rs/favicon.ico")] -#![doc(html_logo_url = "https://rocket.rs/images/logo-boxed.png")] +#![doc(html_root_url = "https://api.rocket.rs/v0.4")] +#![doc(html_favicon_url = "https://rocket.rs/v0.4/images/favicon.ico")] +#![doc(html_logo_url = "https://rocket.rs/v0.4/images/logo-boxed.png")] //! # Rocket - Code Generation //! //! This crate implements the code generation portions of Rocket. This includes //! custom derives, custom attributes, and procedural macros. The documentation //! here is purely technical. The code generation facilities are documented -//! thoroughly in the [Rocket programming guide](https://rocket.rs/guide). +//! thoroughly in the [Rocket programming guide](https://rocket.rs/v0.4/guide). //! //! # Debugging Codegen //! diff --git a/core/http/Cargo.toml b/core/http/Cargo.toml index 6fafee69..43091031 100644 --- a/core/http/Cargo.toml +++ b/core/http/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Sergio Benitez "] description = """ Types, traits, and parsers for HTTP requests, responses, and headers. """ -documentation = "https://api.rocket.rs/rocket_http/" +documentation = "https://api.rocket.rs/v0.4/rocket_http/" homepage = "https://rocket.rs" repository = "https://github.com/SergioBenitez/Rocket" readme = "../../README.md" diff --git a/core/lib/Cargo.toml b/core/lib/Cargo.toml index 97130156..baf00a87 100644 --- a/core/lib/Cargo.toml +++ b/core/lib/Cargo.toml @@ -5,7 +5,7 @@ authors = ["Sergio Benitez "] description = """ Web framework for nightly with a focus on ease-of-use, expressibility, and speed. """ -documentation = "https://api.rocket.rs/0.4.0-dev/rocket/" +documentation = "https://api.rocket.rs/v0.4/rocket/" homepage = "https://rocket.rs" repository = "https://github.com/SergioBenitez/Rocket" readme = "../../README.md" diff --git a/core/lib/build.rs b/core/lib/build.rs index a97750b5..26947f5a 100644 --- a/core/lib/build.rs +++ b/core/lib/build.rs @@ -33,7 +33,7 @@ fn main() { print_version_err(&*version, &*date); eprintln!("{}{}{}", Blue.paint("See the getting started guide ("), - White.paint("https://rocket.rs/guide/getting-started/"), + White.paint("https://rocket.rs/v0.4/guide/getting-started/"), Blue.paint(") for more information.")); panic!("Aborting compilation due to incompatible compiler.") } diff --git a/core/lib/src/fairing/mod.rs b/core/lib/src/fairing/mod.rs index eb040286..b9c744b2 100644 --- a/core/lib/src/fairing/mod.rs +++ b/core/lib/src/fairing/mod.rs @@ -320,7 +320,7 @@ pub use self::info_kind::{Info, Kind}; /// } /// ``` /// -/// [request-local state]: https://rocket.rs/guide/state/#request-local-state +/// [request-local state]: https://rocket.rs/v0.4/guide/state/#request-local-state pub trait Fairing: Send + Sync + 'static { /// Returns an [`Info`] structure containing the `name` and [`Kind`] of this diff --git a/core/lib/src/lib.rs b/core/lib/src/lib.rs index 8a8a4fff..c91a332f 100644 --- a/core/lib/src/lib.rs +++ b/core/lib/src/lib.rs @@ -10,9 +10,9 @@ #![recursion_limit="256"] -#![doc(html_root_url = "https://api.rocket.rs/0.4.0-dev")] -#![doc(html_favicon_url = "https://rocket.rs/favicon.ico")] -#![doc(html_logo_url = "https://rocket.rs/images/logo-boxed.png")] +#![doc(html_root_url = "https://api.rocket.rs/v0.4")] +#![doc(html_favicon_url = "https://rocket.rs/v0.4/images/favicon.ico")] +#![doc(html_logo_url = "https://rocket.rs/v0.4/images/logo-boxed.png")] //! # Rocket - Core API Documentation //! @@ -28,10 +28,10 @@ //! automatic JSON (de)serialiazation, templating support, static file serving, //! and other useful features. //! -//! [overview]: https://rocket.rs/overview -//! [full, detailed guide]: https://rocket.rs/guide -//! [quickstart]: https://rocket.rs/guide/quickstart -//! [getting started]: https://rocket.rs/guide/getting-started +//! [overview]: https://rocket.rs/v0.4/overview +//! [full, detailed guide]: https://rocket.rs/v0.4/guide +//! [quickstart]: https://rocket.rs/v0.4/guide/quickstart +//! [getting started]: https://rocket.rs/v0.4/guide/getting-started //! //! ## Libraries //! @@ -60,7 +60,7 @@ //! # fn main() { rocket::ignite().mount("/", routes![hello]); } //! ``` //! -//! See the [guide](https://rocket.rs/guide) for more information on how to +//! See the [guide](https://rocket.rs/v0.4/guide) for more information on how to //! write Rocket applications. Here's a simple example to get you started: //! //! ```rust @@ -87,7 +87,7 @@ //! configure Rocket, see the [configuration section] of the guide as well as //! the [`config`] module documentation. //! -//! [configuration section]: https://rocket.rs/guide/configuration/ +//! [configuration section]: https://rocket.rs/v0.4/guide/configuration/ //! //! ## Testing //! @@ -96,7 +96,7 @@ //! documentation and the [testing chapter of the guide] include detailed //! examples. //! -//! [testing chapter of the guide]: https://rocket.rs/guide/testing/#testing +//! [testing chapter of the guide]: https://rocket.rs/v0.4/guide/testing/#testing #[allow(unused_imports)] #[macro_use] extern crate rocket_codegen; #[doc(hidden)] pub use rocket_codegen::*; diff --git a/core/lib/src/request/from_request.rs b/core/lib/src/request/from_request.rs index 548ac74f..112cb5e9 100644 --- a/core/lib/src/request/from_request.rs +++ b/core/lib/src/request/from_request.rs @@ -340,7 +340,7 @@ impl IntoOutcome for Result { /// Notice that these request guards provide access to *borrowed* data (`&'a /// User` and `Admin<'a>`) as the data is now owned by the request's cache. /// -/// [request-local state]: https://rocket.rs/guide/state/#request-local-state +/// [request-local state]: https://rocket.rs/v0.4/guide/state/#request-local-state pub trait FromRequest<'a, 'r>: Sized { /// The associated error to be returned if derivation fails. diff --git a/scripts/bump_version.sh b/scripts/bump_version.sh index 9c471d4b..f8ffc647 100755 --- a/scripts/bump_version.sh +++ b/scripts/bump_version.sh @@ -19,11 +19,21 @@ if ! git grep -c "${1}" > /dev/null; then exit 1 fi -today=$(date "+%b %d, %Y") +function major() { + echo "${1}" | cut -d'.' -f1-2 +} -find "${PROJECT_ROOT}" -name "lib.rs" | xargs sed -i.bak "s/${1}/${2}/g" -find "${PROJECT_ROOT}" -name "*.toml" | xargs sed -i.bak "s/${1}/${2}/g" -find "${SITE_ROOT}" -name "*.md" | xargs sed -i.bak "s/${1}/${2}/g" -sed -i.bak "s/^date.*/date = \"$today\"/" "${SITE_ROOT}/index.toml" -sed -i.bak "s/${1}/${2}/g" "${SCRIPT_DIR}/config.sh" +function do_replace() { + find "${PROJECT_ROOT}" -name "*.rs" | xargs sed -i.bak "s/${1}/${2}/g" + find "${PROJECT_ROOT}" -name "*.toml" | xargs sed -i.bak "s/${1}/${2}/g" + find "${SITE_ROOT}" -name "*.md" | xargs sed -i.bak "s/${1}/${2}/g" + sed -i.bak "s/${1}/${2}/g" "${SCRIPT_DIR}/config.sh" + sed -i.bak "s/${1}/${2}/g" "${PROJECT_ROOT}/README.md" +} + +do_replace "v$(major ${1})" "v$(major ${2})" +do_replace "${1}" "${2}" + +# today=$(date "+%b %d, %Y") +# sed -i.bak "s/^date.*/date = \"$today\"/" "${SITE_ROOT}/index.toml" find ${PROJECT_ROOT} -name "*.bak" | xargs rm diff --git a/site/README.md b/site/README.md index 9ddac220..2fe7b6e8 100644 --- a/site/README.md +++ b/site/README.md @@ -13,7 +13,7 @@ This directory contains the following: * `news/*.md` - News articles linked to from `news/index.toml`. * `guide/*.md` - Guide pages linked to from `guide.md`. -[Rocket Programming Guide]: https://rocket.rs/guide/ +[Rocket Programming Guide]: https://rocket.rs/v0.4/guide/ ### Guide Links