system/systeroid
system/systeroid
1
0
Fork 0
mirror of https://github.com/orhun/systeroid synced 2024-07-21 10:25:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

style(docs): create a certain format for the documentation

Browse source
This commit is contained in:
Orhun Parmaksız 2021-11-18 00:38:52 +03:00
parent 4039c09f1a
commit 4828a333b5
No known key found for this signature in database
GPG key ID: F83424824B3E4B90
1 changed files with 25 additions and 13 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
systeroid-core/src/sysctl.rs
View file

@ -88,7 +88,7 @@ pub struct Parameter {
/// Documentation path.
pub docs_path: PathBuf,
/// Title of the kernel parameter taken from the documentation.
pub docs_title: Option<String>,
pub docs_title: String,
}
impl Parameter {
@ -132,19 +132,31 @@ impl Parameter {
Ok(())
}
/// Returns the parameter documentation if it exists.
pub fn get_documentation(&self) -> Option<String> {
self.description.as_ref().map(|description| {
let title = if let Some(absolute_name) = self.name.split('.').last() {
self.docs_title.replacen(absolute_name, &self.name, 1)
} else {
self.name.to_owned()
};
format!(
"{}\n{}\n{}\n-\nReference: {}",
title,
"=".repeat(title.len()),
description,
self.docs_path.to_string_lossy()
)
})
}
/// Prints the description of the kernel parameter to the given output.
pub fn display_documentation<W: Write>(&self, output: &mut W) -> Result<()> {
if let Some(title) = &self.docs_title {
writeln!(output, "{}", title)?;
if let Some(documentation) = self.get_documentation() {
writeln!(output, "{}", documentation)?;
} else {
writeln!(output, "No documentation available")?;
}
writeln!(
output,
"\n{}\n",
self.description
.as_deref()
.unwrap_or("No documentation available")
)?;
writeln!(output, "Reference: {}", self.docs_path.to_string_lossy())?;
Ok(())
}
@ -174,7 +186,7 @@ impl<'a> TryFrom<&'a Ctl> for Parameter {
.and_then(|v| (v == "[N/A]").then(|| None)?),
section: Section::from(ctl.name()?),
docs_path: PathBuf::new(),
docs_title: None,
docs_title: String::new(),
})
}
}
@ -246,7 +258,7 @@ impl Sysctl {
})
{
param.description = Some(paragraph.contents.to_owned());
param.docs_title = Some(paragraph.title.to_owned());
param.docs_title = paragraph.title.to_owned();
param.docs_path = document.path.clone();
continue;
}