canonical/mir

manpages & help

Open

#1,610 opened on Jul 17, 2020

View on GitHub
 (1 comment) (0 reactions) (0 assignees)C++ (137 forks)auto 404
DocumentationGood first issue

Repository metrics

Stars
 (775 stars)
PR merge metrics
 (PR metrics pending)

Description

This came up with 1.8 landing in Debian. From IRC:

https://salsa.debian.org/mir-server-team/mir/-/tree/master/debian/man/man1 the man pages have been writte manually in groff. If you want to keep them that way, that's fine. Other option is help2man, but your --help outputs vary and it was not possible to crank help2man with its options to understand all parts of your --help output of all the scripts. <alan_g> It's a bit of a mess anyway. Our PPA packaging differs from the Ubuntu archive personally, I'd go for standardizing --help output and find good options for help2man. Then the man page problem is gone forever (because you can auto-generate them with every build).

Contributor guide

Research direction
Examine the existing man pages and help output of each script. Identify patterns and inconsistencies. Research help2man options to standardize the output. Then propose changes to the scripts to ensure consistent help output.
Tech stack
cpp
Domain
cli
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65