Merge pull request #1087 from zeenix/book-link-updates

📝 book: Some updates to the book
dbus2 · Oct 19, 2024 · b2fad81 · b2fad81
2 parents fa01a0d + ad203b5
commit b2fad81
Show file tree

Hide file tree

Showing 5 changed files with 25 additions and 27 deletions.
diff --git a/book/src/blocking.md b/book/src/blocking.md
@@ -203,10 +203,10 @@ fn main() -> Result<(), Box<dyn Error>> {
 }
 ```
 
-[asynchronous `Connection` API]: https://docs.rs/zbus/4/zbus/connection/struct.Connection.html
-[`blocking::Connection`]: https://docs.rs/zbus/4/zbus/blocking/connection/struct.Connection.html
+[asynchronous `Connection` API]: https://docs.rs/zbus/5/zbus/connection/struct.Connection.html
+[`blocking::Connection`]: https://docs.rs/zbus/5/zbus/blocking/connection/struct.Connection.html
 [`std::iter::Iterator`]: https://doc.rust-lang.org/nightly/std/iter/trait.Iterator.html
-[blocking module]: https://docs.rs/zbus/4/zbus/blocking/index.html
+[blocking module]: https://docs.rs/zbus/5/zbus/blocking/index.html
 [wkgp]: https://rust-lang.github.io/wg-async-foundations/vision/shiny_future/users_manual.html#caveat-beware-the-async-sandwich
 [`blocking` crate]: https://docs.rs/blocking/
 [assb]: https://docs.rs/async-std/4/async_std/task/fn.spawn_blocking.html

diff --git a/book/src/client.md b/book/src/client.md
@@ -164,9 +164,7 @@ Let's look at this API in action, with an example where we monitor started syste
 ```rust,no_run
 # // NOTE: When changing this, please also keep `zbus/examples/watch-systemd-jobs.rs` in sync.
 use futures_util::stream::StreamExt;
-use zbus::Connection;
-use zbus_macros::proxy;
-use zvariant::OwnedObjectPath;
+use zbus::{zvariant::OwnedObjectPath, proxy, Connection};
 
 # fn main() {
 #     async_io::block_on(watch_systemd_jobs()).expect("Error listening to signal");
@@ -618,7 +616,7 @@ There you have it, a Rust-friendly binding for your D-Bus service!
 [`pkg-config`]: https://www.freedesktop.org/wiki/Software/pkg-config/
 [cob]: blocking.html
 [`Stream`]: https://docs.rs/futures/4/futures/stream/trait.Stream.html
-[`Value`]: https://docs.rs/zvariant/4/zvariant/derive.Value.html
-[`OwnedValue`]: https://docs.rs/zvariant/4/zvariant/derive.OwnedValue.html
+[`Value`]: https://docs.rs/zvariant/5/zvariant/derive.Value.html
+[`OwnedValue`]: https://docs.rs/zvariant/5/zvariant/derive.OwnedValue.html
 
 [^busctl]: `busctl` is part of [`systemd`](https://systemd.io/).
diff --git a/book/src/connection.md b/book/src/connection.md
@@ -72,8 +72,8 @@ cargo feature of `zbus` is enabled.
 [BlueZ]: https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc
 [PID1]: https://www.freedesktop.org/software/systemd/man/latest/org.freedesktop.systemd1.html
 [`futures::stream::Stream`]: https://docs.rs/futures/4/futures/stream/trait.Stream.html
-[`MessageStream`]: https://docs.rs/zbus/4/zbus/struct.MessageStream.html
-[`connection::Builder::address`]: https://docs.rs/zbus/4/zbus/connection/struct.Builder.html#method.address
+[`MessageStream`]: https://docs.rs/zbus/5/zbus/struct.MessageStream.html
+[`connection::Builder::address`]: https://docs.rs/zbus/5/zbus/connection/struct.Builder.html#method.address
 [dspec]: https://dbus.freedesktop.org/doc/dbus-specification.html#addresses
 
 [^bus-less]: Unless you implemented them, none of the bus methods will exist.
diff --git a/book/src/faq.md b/book/src/faq.md
@@ -221,19 +221,19 @@ let s: &str = encoded.deserialize().unwrap().0;
 assert_eq!(s, "Variant2");
 ```
 
-[`proxy::Builder::uncached_properties`]: https://docs.rs/zbus/4/zbus/proxy/struct.Builder.html#method.uncached_properties
-[`proxy::Builder::cache_properites`]: https://docs.rs/zbus/4/zbus/proxy/struct.Builder.html#method.cache_properties
-[`proxy`]: https://docs.rs/zbus/4/zbus/attr.proxy.html
+[`proxy::Builder::uncached_properties`]: https://docs.rs/zbus/5/zbus/proxy/struct.Builder.html#method.uncached_properties
+[`proxy::Builder::cache_properites`]: https://docs.rs/zbus/5/zbus/proxy/struct.Builder.html#method.cache_properties
+[`proxy`]: https://docs.rs/zbus/5/zbus/attr.proxy.html
 [tctiog]: https://github.com/tokio-rs/tokio/issues/2201
-[`Type`]: https://docs.rs/zvariant/4/zvariant/derive.Type.html
-[`SerializeDict`]: https://docs.rs/zvariant/4/zvariant/derive.SerializeDict.html
-[`DeserializeDict`]: https://docs.rs/zvariant/4/zvariant/derive.DeserializeDict.html
-[`MessageStream`]: https://docs.rs/zbus/4/zbus/struct.MessageStream.html
+[`Type`]: https://docs.rs/zvariant/5/zvariant/derive.Type.html
+[`SerializeDict`]: https://docs.rs/zvariant/5/zvariant/derive.SerializeDict.html
+[`DeserializeDict`]: https://docs.rs/zvariant/5/zvariant/derive.DeserializeDict.html
+[`MessageStream`]: https://docs.rs/zbus/5/zbus/struct.MessageStream.html
 [nonull]: https://gitlab.freedesktop.org/dbus/dbus/-/issues/25
 [dsi]: http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces
-[`Optional<T>`]: https://docs.rs/zvariant/4/zvariant/struct.Optional.html
+[`Optional<T>`]: https://docs.rs/zvariant/5/zvariant/struct.Optional.html
 [`d-feet`]: https://wiki.gnome.org/Apps/DFeet
 [specialization]: https://rust-lang.github.io/rfcs/1210-impl-specialization.html
-[`Value`]: https://docs.rs/zvariant/4/zvariant/enum.Value.html
-[`OwnedValue`]: https://docs.rs/zvariant/4/zvariant/struct.OwnedValue.html
+[`Value`]: https://docs.rs/zvariant/5/zvariant/enum.Value.html
+[`OwnedValue`]: https://docs.rs/zvariant/5/zvariant/struct.OwnedValue.html
 [`serde_repr`]: https://crates.io/crates/serde_repr
diff --git a/book/src/service.md b/book/src/service.md
@@ -456,10 +456,10 @@ While it's extremely useful to be able to generate the client-side proxy code di
   proxy as well.
 
 [D-Bus concepts]: concepts.html#bus-name--service-name
-[didoc]: https://docs.rs/zbus/4/zbus/attr.interface.html
-[`Value`]: https://docs.rs/zvariant/4/zvariant/derive.Value.html
-[`OwnedValue`]: https://docs.rs/zvariant/4/zvariant/derive.OwnedValue.html
-[`zbus::DBusError`]:https://docs.rs/zbus/4/zbus/trait.DBusError.html
-[`zbus::fdo::Error`]: https://docs.rs/zbus/4/zbus/fdo/enum.Error.html
-[`zbus::fdo::Error::UnknownProperty`]: https://docs.rs/zbus/4/zbus/fdo/enum.Error.html#variant.UnknownProperty
-[`proxy`]: https://docs.rs/zbus/4/zbus/attr.proxy.html
+[didoc]: https://docs.rs/zbus/5/zbus/attr.interface.html
+[`Value`]: https://docs.rs/zvariant/5/zvariant/derive.Value.html
+[`OwnedValue`]: https://docs.rs/zvariant/5/zvariant/derive.OwnedValue.html
+[`zbus::DBusError`]:https://docs.rs/zbus/5/zbus/trait.DBusError.html
+[`zbus::fdo::Error`]: https://docs.rs/zbus/5/zbus/fdo/enum.Error.html
+[`zbus::fdo::Error::UnknownProperty`]: https://docs.rs/zbus/5/zbus/fdo/enum.Error.html#variant.UnknownProperty
+[`proxy`]: https://docs.rs/zbus/5/zbus/attr.proxy.html