git.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Junio C Hamano <gitster@pobox.com>
To: Felipe Contreras <felipe.contreras@gmail.com>
Cc: git@vger.kernel.org, Jeff King <peff@peff.net>
Subject: Re: [PATCH v2] doc: manpage: remove maximum title length
Date: Wed, 03 May 2023 10:58:24 -0700	[thread overview]
Message-ID: <xmqqr0rxqou7.fsf@gitster.g> (raw)
In-Reply-To: <20230503171658.8996-1-felipe.contreras@gmail.com> (Felipe Contreras's message of "Wed, 3 May 2023 11:16:58 -0600")

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

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

> 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')"/>

  reply	other threads:[~2023-05-03 17:58 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2023-05-03  5:29 [PATCH] doc: manpage: remove maximum title length Felipe Contreras
2023-05-03 16:43 ` Jeff King
2023-05-03 17:09   ` Felipe Contreras
2023-05-03 17:16 ` [PATCH v2] " Felipe Contreras
2023-05-03 17:58   ` Junio C Hamano [this message]
2023-05-03 17:43 ` [PATCH] " Junio C Hamano
2023-05-03 17:49   ` Junio C Hamano
2023-05-08  0:19   ` Felipe Contreras

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=xmqqr0rxqou7.fsf@gitster.g \
    --to=gitster@pobox.com \
    --cc=felipe.contreras@gmail.com \
    --cc=git@vger.kernel.org \
    --cc=peff@peff.net \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).