fbab01a40d
# Objective - clean up documentation and inline examples ## Solution - add missing closing "```" - remove stray "```" - remove whitespace in inline examples - unify inline examples (remove some `rust` labels)
56 lines
1.7 KiB
Rust
56 lines
1.7 KiB
Rust
#![warn(missing_docs)]
|
|
#![allow(clippy::single_component_path_imports)]
|
|
|
|
//! Forces dynamic linking of Bevy.
|
|
//!
|
|
//! Dynamic linking causes Bevy to be built and linked as a dynamic library. This will make
|
|
//! incremental builds compile much faster.
|
|
//!
|
|
//! # Warning
|
|
//!
|
|
//! Do not enable this feature for release builds because this would require you to ship
|
|
//! `libstd.so` and `libbevy_dylib.so` with your game.
|
|
//!
|
|
//! # Enabling dynamic linking
|
|
//!
|
|
//! ## The recommended way
|
|
//!
|
|
//! The easiest way to enable dynamic linking is to use the `--features bevy/dynamic` flag when
|
|
//! using the `cargo run` command:
|
|
//!
|
|
//! `cargo run --features bevy/dynamic`
|
|
//!
|
|
//! ## The unrecommended way
|
|
//!
|
|
//! It is also possible to enable the `dynamic` feature inside of the `Cargo.toml` file. This is
|
|
//! unrecommended because it requires you to remove this feature every time you want to create a
|
|
//! release build to avoid having to ship additional files with your game.
|
|
//!
|
|
//! To enable dynamic linking inside of the `Cargo.toml` file add the `dynamic` feature to the
|
|
//! bevy dependency:
|
|
//!
|
|
//! `features = ["dynamic"]`
|
|
//!
|
|
//! ## The manual way
|
|
//!
|
|
//! Manually enabling dynamic linking is achieved by adding `bevy_dylib` as a dependency and
|
|
//! adding the following code to the `main.rs` file:
|
|
//!
|
|
//! ```
|
|
//! #[allow(unused_imports)]
|
|
//! use bevy_dylib;
|
|
//! ```
|
|
//!
|
|
//! It is recommended to disable the `bevy_dylib` dependency in release mode by adding the
|
|
//! following code to the `use` statement to avoid having to ship additional files with your game:
|
|
//!
|
|
//! ```
|
|
//! #[allow(unused_imports)]
|
|
//! #[cfg(debug_assertions)] // new
|
|
//! use bevy_dylib;
|
|
//! ```
|
|
|
|
// Force linking of the main bevy crate
|
|
#[allow(unused_imports)]
|
|
use bevy_internal;
|