#1072354 Manpage copied without updating title

Package:
apt
Source:
apt
Description:
commandline package manager
Submitter:
Date:
2025-06-16 21:45:01 UTC
Severity:
normal
Tags:
#1072354#5
Date:
2024-06-01 12:46:57 UTC
From:
To:
APT-TRANSPORT-HTTP(1)                 APT                APT-TRANSPORT-HTTP(1)
                  ^========================== "S" forgotten ===============^
NAME
       apt-transport-https - APT transport for downloading via the HTTP Secure
       protocol (HTTPS)

#1072354#10
Date:
2025-05-04 18:25:19 UTC
From:
To:
Hi!
https://salsa.debian.org/apt-team/apt/-/blob/2.6.1/doc/apt-transport-https.1.xml?ref_type=tags
As you can see, the name of the component (apt-transport-https) is
present in a non-truncated form throughout document.

The name of the component, seen in a header of man page, is taken from
this tag in the document (line 20 of xml):
<refentrytitle>apt-transport-https</refentrytitle>

The source file is in DocBook format. The available reference suggests
that maximal length of a title (TH tag in roff markup language) is 20
chars:
  - https://cdn.docbook.org/release/xsl/snapshot/doc/manpages/man.th.title.max.length
  - /usr/share/xml/docbook/stylesheet/docbook-xsl/manpages/param.xsl -> man.th.title.max.length

Count of chars in "APT\-TRANSPORT\-HTTPS" (the escape chars are
necessary in roff document) is 21, which is truncated to 20 chars, and
the ending "S" letter is lost.

To sum up: this issue is a result of inevitable truncation, not a result
of a mistake during copying of files.

Kamil

#1072354#15
Date:
2025-06-07 18:48:30 UTC
From:
To:
Hi,

Since no one has challenged this for a month, I will close this ticket.

Kamil

#1072354#20
Date:
2025-06-10 21:39:32 UTC
From:
To:
Hi!

But this is not an inevitable truncation, docbook could be told to
leave more room before truncation. The link you provide even states as
much:

  The default value is reasonable but somewhat arbitrary. If you have
  pages with long titles, you may want to experiment with changing the
  value in order to achieve the correct aesthetic results.

Having a truncated title is confusing, and I think it can also mess
with the apropos scanning (?).

Thanks,
Guillem

#1072354#25
Date:
2025-06-15 17:39:03 UTC
From:
To:
Control: reopen 1072354
Control: tags 1072354 patch
Control: retitle 1072354 apt: man page title limit exceeded for apt-transport-https/mirror

You are right, I have overlooked this.

I'm attaching a patch (1072354.patch) that increases the value of
relevant xsltproc parameter. The new value will lead to not truncating
of title in apt-transport-https, and in apt-transport-mirror.

This doesn't seem to be the case. It looks like apropos matches searched
substrings in something other than a title:

acerion@debian:~$ apropos apt-transport-http
apt-transport-http (1) - APT transport for downloading via the Hypertext Transfer Protocol (HTTP)
apt-transport-https (1) - APT transport for downloading via the HTTP Secure protocol (HTTPS)
acerion@debian:~$ apropos apt-transport-https
apt-transport-https (1) - APT transport for downloading via the HTTP Secure protocol (HTTPS)

Kamil

#1072354#36
Date:
2025-06-15 21:18:30 UTC
From:
To:
I'm sorry, I can't help anymore with this as my mind now is in a million
different places.

#1072354#41
Date:
2025-06-16 21:43:37 UTC
From:
To:
reopen 1072354