canonical/mir

manpages & help

Open

#1610 aperta il 17 lug 2020

Vedi su GitHub
 (1 commento) (0 reazioni) (0 assegnatari)C++ (137 fork)auto 404
DocumentationGood first issue

Metriche repository

Star
 (775 star)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

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).

Guida contributor

Direzione di ricerca
Esamina le pagine man esistenti e l'output help di ogni script. Identifica modelli e incongruenze. Ricerca le opzioni di help2man per standardizzare l'output. Quindi proponi modifiche agli script per garantire un output help coerente.
Tech stack
cpp
Dominio
cli
Tipo issue
Documentazione
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Git
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65