Re: [PATCH v2] doc: manpage: remove maximum title length

From: Junio C Hamano <gitster@pobox.com>
Date: May 3, 2023, 17:58 UTC
Message-ID: <xmqqr0rxqou7.fsf@gitster.g>
In-Reply-To: <20230503171658.8996-1-felipe.contreras@gmail.com>

Felipe Contreras <felipe.contreras@gmail.com> writes:

Show 8 quoted lines

> DocBook Stylesheets limit the size of the manpage titles for some
> reason.
> ...
> Moreover, asciidoctor manpage backend doesn't limit the title length, so
> we probably want to do the same for docbook backends for consistency.
>
> Signed-off-by: Felipe Contreras <felipe.contreras@gmail.com>
> ---

Looking good. It is especially good that we say why we chose to make it unlimited instead of raising it to some arbitrary value.

The claim that the longest one would fit on a line is not still substantiated (we could say "git-X manual page" needs the most columns and people can check for themselves), but I'll let it pass.

Will queue.  Thanks.

Show 14 quoted lines

> diff --git a/Documentation/manpage-normal.xsl b/Documentation/manpage-normal.xsl
> index a9c7ec69f4..e7aa5df2fc 100644
> --- a/Documentation/manpage-normal.xsl
> +++ b/Documentation/manpage-normal.xsl
> @@ -8,6 +8,9 @@
>  <xsl:param name="man.output.quietly" select="1"/>
>  <xsl:param name="refentry.meta.get.quietly" select="1"/>
>  
> +<!-- unset maximum length of title -->
> +<xsl:param name="man.th.title.max.length"/>
> +
>  <!-- convert asciidoc callouts to man page format -->
>  <xsl:template match="co">
>  	<xsl:value-of select="concat('\fB(',substring-after(@id,'-'),')\fR')"/>