Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 book: Update and fix URLs #594

Merged
merged 2 commits into from
Feb 14, 2024
Merged

📝 book: Update and fix URLs #594

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1645d7e
🩹 book: Fix a 404 link
zeenix Feb 14, 2024
66c4a67
📝 book: Link to version 4 of zbus & zvariant docs.rs URLs
zeenix Feb 14, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions book/src/blocking.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -197,12 +197,12 @@ fn main() -> Result<(), Box<dyn Error>> {
}
```

[asynchronous `Connection` API]: https://docs.rs/zbus/latest/zbus/connection/struct.Connection.html
[`blocking::Connection`]: https://docs.rs/zbus/latest/zbus/blocking/connection/struct.Connection.html
[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
[`std::iter::Iterator`]: https://doc.rust-lang.org/nightly/std/iter/trait.Iterator.html
[blocking module]: https://docs.rs/zbus/latest/zbus/blocking/index.html
[blocking module]: https://docs.rs/zbus/4/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/latest/async_std/task/fn.spawn_blocking.html
[tsb]: https://docs.rs/tokio/latest/tokio/task/fn.spawn_blocking.html
[assb]: https://docs.rs/async-std/4/async_std/task/fn.spawn_blocking.html
[tsb]: https://docs.rs/tokio/4/tokio/task/fn.spawn_blocking.html
[`futures::stream::Stream`]: https://docs.rs/futures/0.3.17/futures/stream/trait.Stream.html
6 changes: 3 additions & 3 deletions book/src/client.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -615,8 +615,8 @@ There you have it, a Rust-friendly binding for your D-Bus service!
[`gdbus-codegen`]: https://docs.gtk.org/gio/migrating-gdbus.html#generating-code-and-docs
[`pkg-config`]: https://www.freedesktop.org/wiki/Software/pkg-config/
[cob]: blocking.html
[`Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
[`Value`]: https://docs.rs/zvariant/latest/zvariant/derive.Value.html
[`OwnedValue`]: https://docs.rs/zvariant/latest/zvariant/derive.OwnedValue.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

[^busctl]: `busctl` is part of [`systemd`](https://www.freedesktop.org/wiki/Software/systemd/).
6 changes: 3 additions & 3 deletions book/src/connection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,9 +73,9 @@ cargo feature of `zbus` is enabled.
[NetworkManager]: https://developer.gnome.org/NetworkManager/stable/spec.html
[BlueZ]: https://git.kernel.org/pub/scm/bluetooth/bluez.git/tree/doc
[PID1]: https://www.freedesktop.org/wiki/Software/systemd/dbus/
[`futures::stream::Stream`]: https://docs.rs/futures/latest/futures/stream/trait.Stream.html
[`MessageStream`]: https://docs.rs/zbus/latest/zbus/struct.MessageStream.html
[`connection::Builder::address`]: https://docs.rs/zbus/latest/zbus/connection/struct.ConnectionBuilder.html#method.address
[`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
[dspec]: https://dbus.freedesktop.org/doc/dbus-specification.html#addresses

[^bus-less] Unless you implemented them, none of the bus methods will exist.
16 changes: 8 additions & 8 deletions book/src/faq.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,16 +147,16 @@ enabled.

**Note**: We hope to be able to remove #2 and #4, once [specialization] lands in stable Rust.

[`proxy::Builder::uncached_properties`]: https://docs.rs/zbus/latest/zbus/proxy/struct.Builder.html#method.uncached_properties
[`proxy::Builder::cache_properites`]: https://docs.rs/zbus/latest/zbus/proxy/struct.Builder.html#method.cache_properties
[`proxy`]: https://docs.rs/zbus/latest/zbus/attr.proxy.html
[`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
[tctiog]: https://github.com/tokio-rs/tokio/issues/2201
[`Type`]: https://docs.rs/zvariant/latest/zvariant/derive.Type.html
[`SerializeDict`]: https://docs.rs/zvariant/latest/zvariant/derive.SerializeDict.html
[`DeserializeDict`]: https://docs.rs/zvariant/latest/zvariant/derive.DeserializeDict.html
[`MessageStream`]: https://docs.rs/zbus/latest/zbus/struct.MessageStream.html
[`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
[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/latest/zvariant/struct.Optional.html
[`Optional<T>`]: https://docs.rs/zvariant/4/zvariant/struct.Optional.html
[`d-feet`]: https://wiki.gnome.org/Apps/DFeet
[specialization]: https://rust-lang.github.io/rfcs/1210-impl-specialization.html
2 changes: 1 addition & 1 deletion book/src/server.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,4 +354,4 @@ iface.greeter_name_changed(iface_ref.signal_context()).await?;
```

[D-Bus concepts]: concepts.html#bus-name--service-name
[didoc]: https://docs.rs/zbus/latest/zbus/attr.interface.html
[didoc]: https://docs.rs/zbus/4/zbus/attr.interface.html
Loading