Skip to content

man: emit .TP for each flag entry to generate linkable anchors #3521

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

Open
ShivangiRay wants to merge 1 commit into
base: master
Choose a base branch
from
+8 −5
Open

man: emit .TP for each flag entry to generate linkable anchors #3521

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 8 additions & 5 deletions crates/core/flags/doc/man.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,8 @@ macro_rules! writeln {
pub(crate) fn generate() -> String {
let mut cats = BTreeMap::new();
for flag in FLAGS.iter().copied() {
let mut cat = cats.entry(flag.doc_category()).or_insert(String::new());
if !cat.is_empty() {
writeln!(cat, ".sp");
}
generate_flag(flag, &mut cat);
let cat = cats.entry(flag.doc_category()).or_insert(String::new());
generate_flag(flag, cat);
}

let mut out = TEMPLATE.replace("!!VERSION!!", &version::generate_digits());
Expand All @@ -50,6 +47,12 @@ pub(crate) fn generate() -> String {

/// Writes `roff` formatted documentation for `flag` to `out`.
fn generate_flag(flag: &'static dyn Flag, out: &mut String) {
// `.TP` starts a tagged paragraph whose tag is the text on the next
// line (the flag names below). Renderers that produce linkable HTML
// from man pages (e.g. mandoc(1), and by extension man.archlinux.org)
// use `.TP`/`.IP` tags to generate per-entry anchor IDs, so this lets
// individual options be linked directly, e.g. `rg.1.html#context`.
writeln!(out, ".TP");
if let Some(byte) = flag.name_short() {
let name = char::from(byte);
write!(out, r"\fB\-{name}\fP");
Expand Down
Loading