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.

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

Fix some minor documentation issues #225

Merged
merged 1 commit into from
Dec 18, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
2 changes: 1 addition & 1 deletion src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#![allow(unknown_lints)]
// The suggested fix with `str::parse` removes support for Rust 1.48
#![allow(clippy::from_str_radix_10)]
#![deny(broken_intra_doc_links)]
#![deny(broken_intra_doc_links, invalid_html_tags)]
//! This crate provides to an interface into the linux `procfs` filesystem, usually mounted at
//! `/proc`.
//!
Expand Down
8 changes: 4 additions & 4 deletions src/process/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -563,7 +563,7 @@ impl MemoryMap {
}
}

/// Represents the information about a specific mapping as presented in /proc/<pid>/smaps
/// Represents the information about a specific mapping as presented in /proc/\<pid\>/smaps
///
/// To construct this structure, see [Process::smaps()]
#[derive(Default, Debug)]
Expand Down Expand Up @@ -1572,15 +1572,15 @@ impl std::iter::Iterator for ProcessesIter {
pub struct StatM {
/// Total program size, measured in pages
///
/// (same as VmSize in /proc/<pid>/status)
/// (same as VmSize in /proc/\<pid\>/status)
pub size: u64,
/// Resident set size, measured in pages
///
/// (same as VmRSS in /proc/<pid>/status)
/// (same as VmRSS in /proc/\<pid\>/status)
pub resident: u64,
/// number of resident shared pages (i.e., backed by a file)
///
/// (same as RssFile+RssShmem in /proc/<pid>/status)
/// (same as RssFile+RssShmem in /proc/\<pid\>/status)
pub shared: u64,
/// Text (code)
pub text: u64,
Expand Down