summaryrefslogtreecommitdiffstats
path: root/src/app
diff options
context:
space:
mode:
authorClement Tsang <34804052+ClementTsang@users.noreply.github.com>2023-06-03 05:44:52 -0400
committerGitHub <noreply@github.com>2023-06-03 05:44:52 -0400
commitc6d322263e8dffb4cc1c36cdcbd0a1922cce58d1 (patch)
tree1d12535f0afd2fe7f2f8fb4889b4c7f50510a735 /src/app
parent852e2e86c7230cb339c7d0482d596194dbb59415 (diff)
other: fix links and broken references in doc comments (#1182)
Diffstat (limited to 'src/app')
-rw-r--r--src/app/data_harvester/disks/unix/linux/counters.rs16
1 files changed, 8 insertions, 8 deletions
diff --git a/src/app/data_harvester/disks/unix/linux/counters.rs b/src/app/data_harvester/disks/unix/linux/counters.rs
index 22134b85..f01d5b7d 100644
--- a/src/app/data_harvester/disks/unix/linux/counters.rs
+++ b/src/app/data_harvester/disks/unix/linux/counters.rs
@@ -16,24 +16,24 @@ use crate::app::data_harvester::disks::IoCounters;
/// via /sys/block/{DISK}/queue/hw_sector_size and results may vary
/// between 1k, 2k, or 4k... 512 appears to be a magic constant used
/// throughout Linux source code:
-/// * https://stackoverflow.com/a/38136179/376587
-/// * https://lists.gt.net/linux/kernel/2241060
-/// * https://github.com/giampaolo/psutil/issues/1305
-/// * https://github.com/torvalds/linux/blob/4f671fe2f9523a1ea206f63fe60a7c7b3a56d5c7/include/linux/bio.h#L99
-/// * https://lkml.org/lkml/2015/8/17/234
+/// * <https://stackoverflow.com/a/38136179/376587>
+/// * <https://lists.gt.net/linux/kernel/2241060>
+/// * <https://github.com/giampaolo/psutil/issues/1305>
+/// * <https://github.com/torvalds/linux/blob/4f671fe2f9523a1ea206f63fe60a7c7b3a56d5c7/include/linux/bio.h#L99>
+/// * <https://lkml.org/lkml/2015/8/17/234>
const DISK_SECTOR_SIZE: u64 = 512;
impl FromStr for IoCounters {
type Err = anyhow::Error;
- /// Converts a `&str` to an [`IoStats`].
+ /// Converts a `&str` to an [`IoCounters`].
///
/// Follows the format used in Linux 2.6+. Note that this completely ignores the following stats:
/// - Discard stats from 4.18+
/// - Flush stats from 5.5+
///
- /// https://www.kernel.org/doc/Documentation/iostats.txt
- /// https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats
+ /// <https://www.kernel.org/doc/Documentation/iostats.txt>
+ /// <https://www.kernel.org/doc/Documentation/ABI/testing/procfs-diskstats>
fn from_str(s: &str) -> anyhow::Result<IoCounters> {
fn next_part<'a>(iter: &mut impl Iterator<Item = &'a str>) -> Result<&'a str, io::Error> {
iter.next()