summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorSebastian Holmin <sebastian.holmin@mullvad.net>2024-07-23 11:44:31 +0200
committerDavid Lönnhager <david.l@mullvad.net>2024-07-26 09:41:18 +0200
commitf7cf1e7ca44b548f8418f89ec4260bae3d8ba0b5 (patch)
tree6544ee1efc826391e5851f573a0d65d60e3df664
parent31a2ccac3816d341920e21f5edc08140b1e5c697 (diff)
downloadmullvadvpn-f7cf1e7ca44b548f8418f89ec4260bae3d8ba0b5.tar.xz
mullvadvpn-f7cf1e7ca44b548f8418f89ec4260bae3d8ba0b5.zip
Fix `doc list item missing indentation`
-rw-r--r--mullvad-api/src/lib.rs2
-rw-r--r--mullvad-management-interface/src/client.rs2
-rw-r--r--mullvad-relay-selector/src/relay_selector/detailer.rs2
-rw-r--r--mullvad-relay-selector/src/relay_selector/mod.rs9
-rw-r--r--mullvad-relay-selector/src/relay_selector/query.rs19
-rw-r--r--mullvad-types/src/constraints/mod.rs4
-rw-r--r--mullvad-types/src/version.rs1
-rw-r--r--talpid-wireguard/src/connectivity_check.rs4
8 files changed, 20 insertions, 23 deletions
diff --git a/mullvad-api/src/lib.rs b/mullvad-api/src/lib.rs
index 85214a9fc0..833dcf3f67 100644
--- a/mullvad-api/src/lib.rs
+++ b/mullvad-api/src/lib.rs
@@ -140,7 +140,7 @@ pub struct ApiEndpoint {
/// useful primarily for testing purposes.
///
/// * If `force_direct` is `true`, bridges and proxies will not be used to
- /// reach the API.
+ /// reach the API.
/// * If `force_direct` is `false`, bridges and proxies can be used to reach the API.
///
/// # Note
diff --git a/mullvad-management-interface/src/client.rs b/mullvad-management-interface/src/client.rs
index bb74b5d748..14ed66ea97 100644
--- a/mullvad-management-interface/src/client.rs
+++ b/mullvad-management-interface/src/client.rs
@@ -159,7 +159,7 @@ impl MullvadProxyClient {
/// in place.
///
/// - `shutdown`: Whether the daemon should shutdown immediately after its prepare-for-restart
- /// routine.
+ /// routine.
pub async fn prepare_restart_v2(&mut self, shutdown: bool) -> Result<()> {
self.0
.prepare_restart_v2(shutdown)
diff --git a/mullvad-relay-selector/src/relay_selector/detailer.rs b/mullvad-relay-selector/src/relay_selector/detailer.rs
index 8b4d446fa3..5c387c41f5 100644
--- a/mullvad-relay-selector/src/relay_selector/detailer.rs
+++ b/mullvad-relay-selector/src/relay_selector/detailer.rs
@@ -53,7 +53,7 @@ pub enum Error {
/// - A configured endpoint for Wireguard relay, encapsulating either a single-hop or multi-hop
/// connection.
/// - Returns [`Option::None`] if the desired port is not in a valid port range (see
-/// [`WireguardRelayQuery::port`]) or relay addresses cannot be resolved.
+/// [`WireguardRelayQuery::port`]) or relay addresses cannot be resolved.
pub fn wireguard_endpoint(
query: &WireguardRelayQuery,
data: &WireguardEndpointData,
diff --git a/mullvad-relay-selector/src/relay_selector/mod.rs b/mullvad-relay-selector/src/relay_selector/mod.rs
index 7f38281fc5..5093ffdeca 100644
--- a/mullvad-relay-selector/src/relay_selector/mod.rs
+++ b/mullvad-relay-selector/src/relay_selector/mod.rs
@@ -216,10 +216,10 @@ pub enum GetRelay {
/// for an arbitrary Wireguard [`query`].
///
/// - [`WireguardConfig::Singlehop`]; A normal wireguard relay where VPN traffic enters and exits
-/// through this sole relay.
+/// through this sole relay.
/// - [`WireguardConfig::Multihop`]; Two wireguard relays to be used in a multihop circuit. VPN
-/// traffic will enter through `entry` and eventually come out from `exit` before the traffic
-/// will actually be routed to the broader internet.
+/// traffic will enter through `entry` and eventually come out from `exit` before the traffic will
+/// actually be routed to the broader internet.
#[derive(Clone, Debug)]
pub enum WireguardConfig {
/// Strongly prefer to instantiate this variant using [`WireguardConfig::singlehop`] as that
@@ -608,8 +608,7 @@ impl RelaySelector {
///
/// # Returns
/// * A randomly selected relay that meets the specified constraints (and a random bridge/entry
- /// relay if applicable).
- /// See [`GetRelay`] for more details.
+ /// relay if applicable). See [`GetRelay`] for more details.
/// * An `Err` if no suitable relay is found
/// * An `Err` if no suitable bridge is found
#[cfg(not(target_os = "android"))]
diff --git a/mullvad-relay-selector/src/relay_selector/query.rs b/mullvad-relay-selector/src/relay_selector/query.rs
index 1fd8b1c5b9..220f232303 100644
--- a/mullvad-relay-selector/src/relay_selector/query.rs
+++ b/mullvad-relay-selector/src/relay_selector/query.rs
@@ -322,10 +322,9 @@ pub mod builder {
/// type of VPN tunnel protocol. Some [`RelayQuery`] options are
/// generic over the VPN protocol, while some options are protocol-specific.
///
- /// - The type parameter `VpnProtocol` keeps track of which VPN protocol that
- /// is being configured. Different instantiations of `VpnProtocol` will
- /// expose different functions for configuring a [`RelayQueryBuilder`]
- /// further.
+ /// - The type parameter `VpnProtocol` keeps track of which VPN protocol that is being
+ /// configured. Different instantiations of `VpnProtocol` will expose different functions for
+ /// configuring a [`RelayQueryBuilder`] further.
pub struct RelayQueryBuilder<VpnProtocol = Any> {
query: RelayQuery,
protocol: VpnProtocol,
@@ -421,9 +420,8 @@ pub mod builder {
/// Internal builder state for a [`WireguardRelayQuery`] configuration.
///
- /// - The type parameter `Multihop` keeps track of the state of multihop.
- /// If multihop has been enabled, the builder should expose an option to
- /// select entry point.
+ /// - The type parameter `Multihop` keeps track of the state of multihop. If multihop has been
+ /// enabled, the builder should expose an option to select entry point.
///
/// [`WireguardRelayQuery`]: super::WireguardRelayQuery
pub struct Wireguard<Multihop, Obfuscation, Daita> {
@@ -531,10 +529,9 @@ pub mod builder {
/// Internal builder state for a [`OpenVpnRelayQuery`] configuration.
///
- /// - The type parameter `TransportPort` keeps track of which
- /// [`TransportProtocol`] & port-combo to use. [`TransportProtocol`] has
- /// to be set first before the option to select a specific port is
- /// exposed.
+ /// - The type parameter `TransportPort` keeps track of which [`TransportProtocol`] & port-combo
+ /// to use. [`TransportProtocol`] has to be set first before the option to select a specific
+ /// port is exposed.
///
/// [`OpenVpnRelayQuery`]: super::OpenVpnRelayQuery
pub struct OpenVPN<TransportPort, Bridge> {
diff --git a/mullvad-types/src/constraints/mod.rs b/mullvad-types/src/constraints/mod.rs
index 493c0ea4d5..0482b50ca0 100644
--- a/mullvad-types/src/constraints/mod.rs
+++ b/mullvad-types/src/constraints/mod.rs
@@ -39,8 +39,8 @@ impl<T: Match<U>, U> Match<U> for Constraint<T> {
/// assert_eq!(query_a.intersection(query_b), None);
/// ```
///
-/// * Otherwise, a new `RelayQuery` is returned where each constraint is
-/// as specific as possible. See [`Constraint`] for further details.
+/// * Otherwise, a new `RelayQuery` is returned where each constraint is as specific as possible.
+/// See [`Constraint`] for further details.
/// ```rust, ignore
/// let query_a = RelayQueryBuilder::new().wireguard().build();
/// let query_b = RelayQueryBuilder::new().location(city("Sweden", "Gothenburg")).build();
diff --git a/mullvad-types/src/version.rs b/mullvad-types/src/version.rs
index 8b696896a7..682070735a 100644
--- a/mullvad-types/src/version.rs
+++ b/mullvad-types/src/version.rs
@@ -21,6 +21,7 @@ pub struct AppVersionInfo {
/// * API endpoints it uses might not work any more.
/// * Software bundled with this version, such as OpenVPN or OpenSSL, has known security
/// issues, so using it is no longer recommended.
+ ///
/// The user should really upgrade when this is false.
pub supported: bool,
/// Latest stable version
diff --git a/talpid-wireguard/src/connectivity_check.rs b/talpid-wireguard/src/connectivity_check.rs
index 4514df0495..608002d1a6 100644
--- a/talpid-wireguard/src/connectivity_check.rs
+++ b/talpid-wireguard/src/connectivity_check.rs
@@ -64,9 +64,9 @@ pub enum Error {
/// The connectivity monitor will start sending pings and start the countdown to `PING_TIMEOUT` in
/// the following cases:
/// - In case that we have observed a bump in the outgoing traffic but no corresponding incoming
-/// traffic for longer than `BYTES_RX_TIMEOUT`, then the monitor will start pinging.
+/// traffic for longer than `BYTES_RX_TIMEOUT`, then the monitor will start pinging.
/// - In case that no increase in outgoing or incoming traffic has been observed for longer than
-/// `TRAFFIC_TIMEOUT`, then the monitor will start pinging as well.
+/// `TRAFFIC_TIMEOUT`, then the monitor will start pinging as well.
///
/// Once a connection established, a connection is only considered broken once the connectivity
/// monitor has started pinging and no traffic has been received for a duration of `PING_TIMEOUT`.