One place to assemble synopsis, aliases, and detection metadata.
(
gz_path: str,
options: list[models.Option],
*,
dashless_opts: bool = False,
subcommands: list[str] | None = None,
extractor: str | None = None,
extraction_meta: models.ExtractionMeta | None = None,
)
| 17 | |
| 18 | |
| 19 | def build_manpage_metadata( |
| 20 | gz_path: str, |
| 21 | options: list[models.Option], |
| 22 | *, |
| 23 | dashless_opts: bool = False, |
| 24 | subcommands: list[str] | None = None, |
| 25 | extractor: str | None = None, |
| 26 | extraction_meta: models.ExtractionMeta | None = None, |
| 27 | ) -> models.ParsedManpage: |
| 28 | """One place to assemble synopsis, aliases, and detection metadata.""" |
| 29 | synopsis, aliases = manpage.get_synopsis_and_aliases(gz_path) |
| 30 | return models.ParsedManpage( |
| 31 | source=config.source_from_path(gz_path), |
| 32 | name=manpage.extract_name(gz_path), |
| 33 | synopsis=synopsis, |
| 34 | options=options, |
| 35 | aliases=aliases, |
| 36 | dashless_opts=dashless_opts, |
| 37 | nested_cmd=roff_utils.detect_nested_cmd(gz_path), |
| 38 | subcommands=subcommands or [], |
| 39 | extractor=extractor, |
| 40 | extraction_meta=extraction_meta, |
| 41 | ) |
| 42 | |
| 43 | |
| 44 | def build_raw_manpage( |