Mirrors/bevy
2
0
Fork 0
mirror of https://github.com/bevyengine/bevy synced 2024-11-10 07:04:33 +00:00
Code Issues Projects Releases Packages Wiki Activity
bevy/crates/bevy_tasks/Cargo.toml

35 lines
875 B
TOML
Raw Normal View History

Task System for Bevy (#384) Add bevy_tasks crate to replace rayon
2020-08-29 19:35:41 +00:00
[package]
name = "bevy_tasks"
Bump Version after Release (#14219) Bump version after release This PR has been auto-generated Co-authored-by: Bevy Auto Releaser <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: François Mockers <mockersf@gmail.com>
2024-07-08 12:54:08 +00:00
version = "0.15.0-dev"
Update to edition 2021 on master (#3028) Objective During work on #3009 I've found that not all jobs use actions-rs, and therefore, an previous version of Rust is used for them. So while compilation and other stuff can pass, checking markup and Android build may fail with compilation errors. Solution This PR adds `action-rs` for any job running cargo, and updates the edition to 2021.
2021-10-27 00:12:14 +00:00
edition = "2021"
release: 0.3.0 (#783)
2020-11-03 21:34:00 +00:00
description = "A task executor for Bevy Engine"
homepage = "https://bevyengine.org"
repository = "https://github.com/bevyengine/bevy"
Relicense Bevy under the dual MIT or Apache-2.0 license (#2509) This relicenses Bevy under the dual MIT or Apache-2.0 license. For rationale, see #2373. * Changes the LICENSE file to describe the dual license. Moved the MIT license to docs/LICENSE-MIT. Added the Apache-2.0 license to docs/LICENSE-APACHE. I opted for this approach over dumping both license files at the root (the more common approach) for a number of reasons: * Github links to the "first" license file (LICENSE-APACHE) in its license links (you can see this in the wgpu and rust-analyzer repos). People clicking these links might erroneously think that the apache license is the only option. Rust and Amethyst both use COPYRIGHT or COPYING files to solve this problem, but this creates more file noise (if you do everything at the root) and the naming feels way less intuitive. * People have a reflex to look for a LICENSE file. By providing a single license file at the root, we make it easy for them to understand our licensing approach. * I like keeping the root clean and noise free * There is precedent for putting the apache and mit license text in sub folders (amethyst) * Removed the `Copyright (c) 2020 Carter Anderson` copyright notice from the MIT license. I don't care about this attribution, it might make license compliance more difficult in some cases, and it didn't properly attribute other contributors. We shoudn't replace it with something like "Copyright (c) 2021 Bevy Contributors" because "Bevy Contributors" is not a legal entity. Instead, we just won't include the copyright line (which has precedent ... Rust also uses this approach). * Updates crates to use the new "MIT OR Apache-2.0" license value * Removes the old legion-transform license file from bevy_transform. bevy_transform has been its own, fully custom implementation for a long time and that license no longer applies. * Added a License section to the main readme * Updated our Bevy Plugin licensing guidelines. As a follow-up we should update the website to properly describe the new license. Closes #2373
2021-07-23 21:11:51 +00:00
license = "MIT OR Apache-2.0"
release: 0.3.0 (#783)
2020-11-03 21:34:00 +00:00
keywords = ["bevy"]
Task System for Bevy (#384) Add bevy_tasks crate to replace rayon
2020-08-29 19:35:41 +00:00
Add optional single-threaded feature to bevy_ecs/bevy_tasks (#6690) # Objective Fixes #6689. ## Solution Add `single-threaded` as an optional non-default feature to `bevy_ecs` and `bevy_tasks` that: - disable the `ParallelExecutor` as a default runner - disables the multi-threaded `TaskPool` - internally replace `QueryParIter::for_each` calls with `Query::for_each`. Removed the `Mutex` and `Arc` usage in the single-threaded task pool. ![image](https://user-images.githubusercontent.com/3137680/202833253-dd2d520f-75e6-4c7b-be2d-5ce1523cbd38.png) ## Future Work/TODO Create type aliases for `Mutex`, `Arc` that change to single-threaaded equivalents where possible. --- ## Changelog Added: Optional default feature `multi-theaded` to that enables multithreaded parallelism in the engine. Disabling it disables all multithreading in exchange for higher single threaded performance. Does nothing on WASM targets. --------- Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2023-07-09 04:22:15 +00:00
[features]
multi_threaded feature rename (#12997) # Objective Fixes #12966 ## Solution Renaming multi_threaded feature to match snake case ## Migration Guide Bevy feature multi-threaded should be refered to multi_threaded from now on.
2024-05-06 20:49:32 +00:00
multi_threaded = ["dep:async-channel", "dep:concurrent-queue"]
Add optional single-threaded feature to bevy_ecs/bevy_tasks (#6690) # Objective Fixes #6689. ## Solution Add `single-threaded` as an optional non-default feature to `bevy_ecs` and `bevy_tasks` that: - disable the `ParallelExecutor` as a default runner - disables the multi-threaded `TaskPool` - internally replace `QueryParIter::for_each` calls with `Query::for_each`. Removed the `Mutex` and `Arc` usage in the single-threaded task pool. ![image](https://user-images.githubusercontent.com/3137680/202833253-dd2d520f-75e6-4c7b-be2d-5ce1523cbd38.png) ## Future Work/TODO Create type aliases for `Mutex`, `Arc` that change to single-threaaded equivalents where possible. --- ## Changelog Added: Optional default feature `multi-theaded` to that enables multithreaded parallelism in the engine. Disabling it disables all multithreading in exchange for higher single threaded performance. Does nothing on WASM targets. --------- Co-authored-by: Carter Anderson <mcanders1@gmail.com>
2023-07-09 04:22:15 +00:00
Task System for Bevy (#384) Add bevy_tasks crate to replace rayon
2020-08-29 19:35:41 +00:00
[dependencies]
bump bevy_tasks futures-lite to 2.0.1 (#10675) # Objective Updates [`futures-lite`](https://github.com/smol-rs/futures-lite) in bevy_tasks to the next major version (1 -> 2). Also removes the duplication of `futures-lite`, as `async-fs` requires v 2, so there are currently 2 copies of futures-lite in the dependency tree. Futures-lite has received [a number of updates](https://github.com/smol-rs/futures-lite/blob/master/CHANGELOG.md) since bevy's current version `1.4`. --------- Co-authored-by: Alice Cecile <alice.i.cecile@gmail.com> Co-authored-by: Mike <mike.hsu@gmail.com>
2023-11-24 00:11:02 +00:00
futures-lite = "2.0.1"
Remove async-task as a dependency (#13071) # Objective Follow up to #13062. As of async-executor 1.11, the crate reexports FallibleTask, which is the only reason bevy_tasks has a direct dependency on async-task. This should avoid the two dependencies getting out of sync in the future and causing spurious compilation failures. ## Solution Bump async-executor to 1.11, use the reexport, remove the dependency on async-task.
2024-04-23 14:57:55 +00:00
async-executor = "1.11"
Clean up some low level dependencies (#12858) # Objective Minimize the number of dependencies low in the tree. ## Solution * Remove the dependency on rustc-hash in bevy_ecs (not used) and bevy_macro_utils (only used in one spot). * Deduplicate the dependency on `sha1_smol` with the existing blake3 dependency already being used for bevy_asset. * Remove the unused `ron` dependency on `bevy_app` * Make the `serde` dependency for `bevy_ecs` optional. It's only used for serializing Entity. * Change the `wgpu` dependency to `wgpu-types`, and make it optional for `bevy_color`. * Remove the unused `thread-local` dependency on `bevy_render`. * Make multiple dependencies for `bevy_tasks` optional and enabled only when running with the `multi-threaded` feature. Preferably they'd be disabled all the time on wasm, but I couldn't find a clean way to do this. --- ## Changelog TODO ## Migration Guide TODO
2024-04-08 19:45:42 +00:00
async-channel = { version = "2.2.0", optional = true }
Update async-io requirement from 1.13.0 to 2.0.0 (#10238) Updates the requirements on [async-io](https://github.com/smol-rs/async-io) to permit the latest version. <details> <summary>Release notes</summary> <p><em>Sourced from <a href="https://github.com/smol-rs/async-io/releases">async-io's releases</a>.</em></p> <blockquote> <h2>v2.0.0</h2> <ul> <li><strong>Breaking:</strong> <code>Async::new()</code> now takes types that implement <code>AsFd</code>/<code>AsSocket</code> instead of <code>AsRawFd</code>/<code>AsRawSocket</code>, in order to implement I/O safety. (<a href="https://redirect.github.com/smol-rs/async-io/issues/142">#142</a>)</li> <li><strong>Breaking:</strong> <code>Async::get_mut()</code>, <code>Async::read_with_mut()</code> and <code>Async::write_with_mut()</code> are now <code>unsafe</code>. The underlying source is technically &quot;borrowed&quot; by the polling instance, so moving it out would be unsound. (<a href="https://redirect.github.com/smol-rs/async-io/issues/142">#142</a>)</li> <li>Expose miscellaneous <code>kqueue</code> filters in the <code>os::kqueue</code> module. (<a href="https://redirect.github.com/smol-rs/async-io/issues/112">#112</a>)</li> <li>Expose a way to get the underlying <code>Poller</code>'s file descriptor on Unix. (<a href="https://redirect.github.com/smol-rs/async-io/issues/125">#125</a>)</li> <li>Add a new <code>Async::new_nonblocking</code> method to allow users to avoid duplicating an already nonblocking socket. (<a href="https://redirect.github.com/smol-rs/async-io/issues/159">#159</a>)</li> <li>Remove the unused <code>fastrand</code> and <code>memchr</code> dependencies. (<a href="https://redirect.github.com/smol-rs/async-io/issues/131">#131</a>)</li> <li>Use <code>tracing</code> instead of <code>log</code>. (<a href="https://redirect.github.com/smol-rs/async-io/issues/140">#140</a>)</li> <li>Support ESP-IDF. (<a href="https://redirect.github.com/smol-rs/async-io/issues/144">#144</a>)</li> <li>Optimize the <code>block_on</code> function to reduce allocation, leading to a slight performance improvement. (<a href="https://redirect.github.com/smol-rs/async-io/issues/149">#149</a>)</li> </ul> </blockquote> </details> <details> <summary>Changelog</summary> <p><em>Sourced from <a href="https://github.com/smol-rs/async-io/blob/master/CHANGELOG.md">async-io's changelog</a>.</em></p> <blockquote> <h1>Version 2.0.0</h1> <ul> <li><strong>Breaking:</strong> <code>Async::new()</code> now takes types that implement <code>AsFd</code>/<code>AsSocket</code> instead of <code>AsRawFd</code>/<code>AsRawSocket</code>, in order to implement I/O safety. (<a href="https://redirect.github.com/smol-rs/async-io/issues/142">#142</a>)</li> <li><strong>Breaking:</strong> <code>Async::get_mut()</code>, <code>Async::read_with_mut()</code> and <code>Async::write_with_mut()</code> are now <code>unsafe</code>. The underlying source is technically &quot;borrowed&quot; by the polling instance, so moving it out would be unsound. (<a href="https://redirect.github.com/smol-rs/async-io/issues/142">#142</a>)</li> <li>Expose miscellaneous <code>kqueue</code> filters in the <code>os::kqueue</code> module. (<a href="https://redirect.github.com/smol-rs/async-io/issues/112">#112</a>)</li> <li>Expose a way to get the underlying <code>Poller</code>'s file descriptor on Unix. (<a href="https://redirect.github.com/smol-rs/async-io/issues/125">#125</a>)</li> <li>Add a new <code>Async::new_nonblocking</code> method to allow users to avoid duplicating an already nonblocking socket. (<a href="https://redirect.github.com/smol-rs/async-io/issues/159">#159</a>)</li> <li>Remove the unused <code>fastrand</code> and <code>memchr</code> dependencies. (<a href="https://redirect.github.com/smol-rs/async-io/issues/131">#131</a>)</li> <li>Use <code>tracing</code> instead of <code>log</code>. (<a href="https://redirect.github.com/smol-rs/async-io/issues/140">#140</a>)</li> <li>Support ESP-IDF. (<a href="https://redirect.github.com/smol-rs/async-io/issues/144">#144</a>)</li> <li>Optimize the <code>block_on</code> function to reduce allocation, leading to a slight performance improvement. (<a href="https://redirect.github.com/smol-rs/async-io/issues/149">#149</a>)</li> </ul> <h1>Version 1.13.0</h1> <ul> <li>Use <a href="https://crates.io/crates/rustix/"><code>rustix</code></a> instead of <a href="https://crates.io/crates/libc/"><code>libc</code></a>/<a href="https://crates.io/crates/windows-sys/"><code>windows-sys</code></a> for system calls (<a href="https://redirect.github.com/smol-rs/async-io/issues/76">#76</a>)</li> <li>Add a <code>will_fire</code> method to <code>Timer</code> to test if it will ever fire (<a href="https://redirect.github.com/smol-rs/async-io/issues/106">#106</a>)</li> <li>Reduce syscalls in <code>Async::new</code> (<a href="https://redirect.github.com/smol-rs/async-io/issues/107">#107</a>)</li> <li>Improve the drop ergonomics of <code>Readable</code> and <code>Writable</code> (<a href="https://redirect.github.com/smol-rs/async-io/issues/109">#109</a>)</li> <li>Change the &quot;<code>wepoll</code>&quot; in documentation to &quot;<code>IOCP</code>&quot; (<a href="https://redirect.github.com/smol-rs/async-io/issues/116">#116</a>)</li> </ul> <h1>Version 1.12.0</h1> <ul> <li>Switch from <code>winapi</code> to <code>windows-sys</code> (<a href="https://redirect.github.com/smol-rs/async-io/issues/102">#102</a>)</li> </ul> <h1>Version 1.11.0</h1> <ul> <li>Update <code>concurrent-queue</code> to v2. (<a href="https://redirect.github.com/smol-rs/async-io/issues/99">#99</a>)</li> </ul> <h1>Version 1.10.0</h1> <ul> <li>Remove the dependency on the <code>once_cell</code> crate to restore the MSRV. (<a href="https://redirect.github.com/smol-rs/async-io/issues/95">#95</a>)</li> </ul> <h1>Version 1.9.0</h1> <ul> <li>Fix panic on very large durations. (<a href="https://redirect.github.com/smol-rs/async-io/issues/87">#87</a>)</li> <li>Add <code>Timer::never</code> (<a href="https://redirect.github.com/smol-rs/async-io/issues/87">#87</a>)</li> </ul> <h1>Version 1.8.0</h1> <ul> <li>Implement I/O safety traits on Rust 1.63+ (<a href="https://redirect.github.com/smol-rs/async-io/issues/84">#84</a>)</li> </ul> <h1>Version 1.7.0</h1> <ul> <li>Process timers set for exactly <code>now</code>. (<a href="https://redirect.github.com/smol-rs/async-io/issues/73">#73</a>)</li> </ul> <h1>Version 1.6.0</h1> <!-- raw HTML omitted --> </blockquote> <p>... (truncated)</p> </details> <details> <summary>Commits</summary> <ul> <li><a href="https://github.com/smol-rs/async-io/commit/7e89eec4d15d70215f5a96f7f66a3c0224aa90a5"><code>7e89eec</code></a> v2.0.0</li> <li><a href="https://github.com/smol-rs/async-io/commit/356431754cb3756d1c9f59f29c11c04a7f353ffa"><code>3564317</code></a> tests: Add test for <a href="https://redirect.github.com/smol-rs/async-io/issues/154">#154</a></li> <li><a href="https://github.com/smol-rs/async-io/commit/a5da16f07268c5be34818f18920496ff2fc60da3"><code>a5da16f</code></a> Expose Async::new_nonblocking</li> <li><a href="https://github.com/smol-rs/async-io/commit/0f2af634d8272006e6135d7fd23f3b636908d713"><code>0f2af63</code></a> Avoid needless set_nonblocking calls</li> <li><a href="https://github.com/smol-rs/async-io/commit/62e3454f3807ec6ece80ef3abc8cfdc3a41b58bf"><code>62e3454</code></a> Migrate to Rust 2021 (<a href="https://redirect.github.com/smol-rs/async-io/issues/160">#160</a>)</li> <li><a href="https://github.com/smol-rs/async-io/commit/59ee2ea27c5add95d09947f592149811024d7527"><code>59ee2ea</code></a> Use set_nonblocking in Async::new on Windows (<a href="https://redirect.github.com/smol-rs/async-io/issues/157">#157</a>)</li> <li><a href="https://github.com/smol-rs/async-io/commit/d5bc619021b056f0e334950a22a756e1733e3812"><code>d5bc619</code></a> Remove needless as_fd/as_socket calls (<a href="https://redirect.github.com/smol-rs/async-io/issues/158">#158</a>)</li> <li><a href="https://github.com/smol-rs/async-io/commit/0b5016e567d50f72e8fc404dee91e307235756f9"><code>0b5016e</code></a> m: Replace socket2 calls with rustix</li> <li><a href="https://github.com/smol-rs/async-io/commit/8c3c3bd80bd3aac02534a2166298f84127065c09"><code>8c3c3bd</code></a> m: Optimize block_on by caching Parker and Waker</li> <li><a href="https://github.com/smol-rs/async-io/commit/1b1466a6c17327fcd8b7e9a3ec43ebcff2bcc471"><code>1b1466a</code></a> Update this crate to use the new polling breaking changes (<a href="https://redirect.github.com/smol-rs/async-io/issues/142">#142</a>)</li> <li>Additional commits viewable in <a href="https://github.com/smol-rs/async-io/compare/v1.13.0...v2.0.0">compare view</a></li> </ul> </details> <br /> Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting `@dependabot rebase`. [//]: # (dependabot-automerge-start) [//]: # (dependabot-automerge-end) --- <details> <summary>Dependabot commands and options</summary> <br /> You can trigger Dependabot actions by commenting on this PR: - `@dependabot rebase` will rebase this PR - `@dependabot recreate` will recreate this PR, overwriting any edits that have been made to it - `@dependabot merge` will merge this PR after your CI passes on it - `@dependabot squash and merge` will squash and merge this PR after your CI passes on it - `@dependabot cancel merge` will cancel a previously requested merge and block automerging - `@dependabot reopen` will reopen this PR if it is closed - `@dependabot close` will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually - `@dependabot show <dependency name> ignore conditions` will show all of the ignore conditions of the specified dependency - `@dependabot ignore this major version` will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this minor version` will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself) - `@dependabot ignore this dependency` will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself) </details> Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-10-23 23:49:57 +00:00
async-io = { version = "2.0.0", optional = true }
Clean up some low level dependencies (#12858) # Objective Minimize the number of dependencies low in the tree. ## Solution * Remove the dependency on rustc-hash in bevy_ecs (not used) and bevy_macro_utils (only used in one spot). * Deduplicate the dependency on `sha1_smol` with the existing blake3 dependency already being used for bevy_asset. * Remove the unused `ron` dependency on `bevy_app` * Make the `serde` dependency for `bevy_ecs` optional. It's only used for serializing Entity. * Change the `wgpu` dependency to `wgpu-types`, and make it optional for `bevy_color`. * Remove the unused `thread-local` dependency on `bevy_render`. * Make multiple dependencies for `bevy_tasks` optional and enabled only when running with the `multi-threaded` feature. Preferably they'd be disabled all the time on wasm, but I couldn't find a clean way to do this. --- ## Changelog TODO ## Migration Guide TODO
2024-04-08 19:45:42 +00:00
concurrent-queue = { version = "2.0.0", optional = true }
Remove unused deps (#2455) # Objective Reduce compilation time # Solution Remove unused dependencies. While this PR doesn't remove any crates from `Cargo.lock`, it may unlock more build parallelism.
2021-07-14 20:52:50 +00:00
WASM asset loading (#559) wasm assets
2020-09-25 22:26:23 +00:00
[target.'cfg(target_arch = "wasm32")'.dependencies]
wasm-bindgen-futures = "0.4"
Make `Task`s functional on WASM (#13889) # Objective Right not bevy's task pool abstraction is kind of useless on wasm, since it returns a `FakeTask` which can't be interacted with. This is only good for fire-and-forget it tasks, and isn't even that useful since it's just a thin wrapper around `wasm-bindgen-futures::spawn_local` ## Solution Add a simple `Task<T>` handler type to wasm targets that allow waiting for a task's output or periodically checking for its completion. This PR aims to give the wasm version of these tasks feature parity with the native, multi-threaded version of the task ## Testing - Did you test these changes? *Not yet* --------- Co-authored-by: Periwink <charlesbour@gmail.com> Co-authored-by: Jan Hohenheim <jan@hohenheim.ch>
2024-07-16 01:15:03 +00:00
pin-project = "1"
futures-channel = "0.3"
Remove unused deps (#2455) # Objective Reduce compilation time # Solution Remove unused dependencies. While this PR doesn't remove any crates from `Cargo.lock`, it may unlock more build parallelism.
2021-07-14 20:52:50 +00:00
[dev-dependencies]
fix: upgrade to winit v0.30 (#13366) # Objective - Upgrade winit to v0.30 - Fixes https://github.com/bevyengine/bevy/issues/13331 ## Solution This is a rewrite/adaptation of the new trait system described and implemented in `winit` v0.30. ## Migration Guide The custom UserEvent is now renamed as WakeUp, used to wake up the loop if anything happens outside the app (a new [custom_user_event](https://github.com/bevyengine/bevy/pull/13366/files#diff-2de8c0a8d3028d0059a3d80ae31b2bbc1cde2595ce2d317ea378fe3e0cf6ef2d) shows this behavior. The internal `UpdateState` has been removed and replaced internally by the AppLifecycle. When changed, the AppLifecycle is sent as an event. The `UpdateMode` now accepts only two values: `Continuous` and `Reactive`, but the latter exposes 3 new properties to enable reactive to device, user or window events. The previous `UpdateMode::Reactive` is now equivalent to `UpdateMode::reactive()`, while `UpdateMode::ReactiveLowPower` to `UpdateMode::reactive_low_power()`. The `ApplicationLifecycle` has been renamed as `AppLifecycle`, and now contains the possible values of the application state inside the event loop: * `Idle`: the loop has not started yet * `Running` (previously called `Started`): the loop is running * `WillSuspend`: the loop is going to be suspended * `Suspended`: the loop is suspended * `WillResume`: the loop is going to be resumed Note: the `Resumed` state has been removed since the resumed app is just running. Finally, now that `winit` enables this, it extends the `WinitPlugin` to support custom events. ## Test platforms - [x] Windows - [x] MacOs - [x] Linux (x11) - [x] Linux (Wayland) - [x] Android - [x] iOS - [x] WASM/WebGPU - [x] WASM/WebGL2 ## Outstanding issues / regressions - [ ] iOS: build failed in CI - blocking, but may just be flakiness - [x] Cross-platform: when the window is maximised, changes in the scale factor don't apply, to make them apply one has to make the window smaller again. (Re-maximising keeps the updated scale factor) - non-blocking, but good to fix - [ ] Android: it's pretty easy to quickly open and close the app and then the music keeps playing when suspended. - non-blocking but worrying - [ ] Web: the application will hang when switching tabs - Not new, duplicate of https://github.com/bevyengine/bevy/issues/13486 - [ ] Cross-platform?: Screenshot failure, `ERROR present_frames: wgpu_core::present: No work has been submitted for this frame before` taking the first screenshot, but after pressing space - non-blocking, but good to fix --------- Co-authored-by: François <francois.mockers@vleue.com>
2024-06-03 13:06:48 +00:00
web-time = { version = "1.1" }
Add [lints] table, fix adding `#![allow(clippy::type_complexity)]` everywhere (#10011) # Objective - Fix adding `#![allow(clippy::type_complexity)]` everywhere. like #9796 ## Solution - Use the new [lints] table that will land in 1.74 (https://doc.rust-lang.org/nightly/cargo/reference/unstable.html#lints) - inherit lint to the workspace, crates and examples. ``` [lints] workspace = true ``` ## Changelog - Bump rust version to 1.74 - Enable lints table for the workspace ```toml [workspace.lints.clippy] type_complexity = "allow" ``` - Allow type complexity for all crates and examples ```toml [lints] workspace = true ``` --------- Co-authored-by: Martín Maita <47983254+mnmaita@users.noreply.github.com>
2023-11-18 20:58:48 +00:00
[lints]
workspace = true
Add "all-features = true" to docs.rs metadata for most crates (#12366) # Objective Fix missing `TextBundle` (and many others) which are present in the main crate as default features but optional in the sub-crate. See: - https://docs.rs/bevy/0.13.0/bevy/ui/node_bundles/index.html - https://docs.rs/bevy_ui/0.13.0/bevy_ui/node_bundles/index.html ~~There are probably other instances in other crates that I could track down, but maybe "all-features = true" should be used by default in all sub-crates? Not sure.~~ (There were many.) I only noticed this because rust-analyzer's "open docs" features takes me to the sub-crate, not the main one. ## Solution Add "all-features = true" to docs.rs metadata for crates that use features. ## Changelog ### Changed - Unified features documented on docs.rs between main crate and sub-crates
2024-03-08 20:03:09 +00:00
[package.metadata.docs.rs]
Generate links to definition in source code pages on docs.rs and dev-docs.bevyengine.org (#12965) # Objective - Fix issue #2611 ## Solution - Add `--generate-link-to-definition` to all the `rustdoc-args` arrays in the `Cargo.toml`s (for docs.rs) - Add `--generate-link-to-definition` to the `RUSTDOCFLAGS` environment variable in the docs workflow (for dev-docs.bevyengine.org) - Document all the workspace crates in the docs workflow (needed because otherwise only the source code of the `bevy` package will be included, making the argument useless) - I think this also fixes #3662, since it fixes the bug on dev-docs.bevyengine.org, while on docs.rs it has been fixed for a while on their side. --- ## Changelog - The source code viewer on docs.rs now includes links to the definitions.
2024-07-29 23:10:16 +00:00
rustdoc-args = ["-Zunstable-options", "--generate-link-to-definition"]
Add "all-features = true" to docs.rs metadata for most crates (#12366) # Objective Fix missing `TextBundle` (and many others) which are present in the main crate as default features but optional in the sub-crate. See: - https://docs.rs/bevy/0.13.0/bevy/ui/node_bundles/index.html - https://docs.rs/bevy_ui/0.13.0/bevy_ui/node_bundles/index.html ~~There are probably other instances in other crates that I could track down, but maybe "all-features = true" should be used by default in all sub-crates? Not sure.~~ (There were many.) I only noticed this because rust-analyzer's "open docs" features takes me to the sub-crate, not the main one. ## Solution Add "all-features = true" to docs.rs metadata for crates that use features. ## Changelog ### Changed - Unified features documented on docs.rs between main crate and sub-crates
2024-03-08 20:03:09 +00:00
all-features = true
Reference in a new issue Copy permalink