Linux-man Archive on lore.kernel.org
 help / color / Atom feed
From: "Michael Kerrisk (man-pages)" <mtk.manpages@gmail.com>
To: "G. Branden Robinson" <g.branden.robinson@gmail.com>
Cc: linux-man <linux-man@vger.kernel.org>
Subject: Re: [PATCH] drop spurious t comment header
Date: Fri, 24 Jul 2020 12:13:33 +0200
Message-ID: <CAKgNAkjwwxrM_ry-b1rtrVc8YjfNE=p4iAht85P+mBs6Eq0U-w@mail.gmail.com> (raw)
In-Reply-To: <20200724000315.yx5otylik6oqqy6d@localhost.localdomain>

Hi Branden, Mike,

On Fri, 24 Jul 2020 at 02:03, G. Branden Robinson
<g.branden.robinson@gmail.com> wrote:
>
> At 2020-07-23T17:53:33-0400, Mike Frysinger wrote:
> > From: Mike Frysinger <vapier@chromium.org>
> >
> > A bunch of pages have this random comment at the start of its header,
> > but most do not.  Just trim it everywhere.
>
> It's pretty misleading to call it "random";

(True.)

> it is a hint to the man
> program to preprocess the man page text through tbl.

Yes, that's my understanding. But I believe that these days it's no
longer needed(?). tbl(1) just gets used as needed, regardless of the
presence of the 't' comment, right?

> This is documented in subsection "Interaction with preprocessors" of
> groff_man(5).
>
> The patch itself might be fine; the first couple of pages it alters
> indeed use no tables, according to the check I ran:
>         grep -l '^\.\s*TS' man[1-8]/*
>
> ...but the comment is certainly not meaningless noise, which is what
> "random" suggests, and I would not characterize the change this in a
> commit message.

See my comments above. For 15 years or at least, I've not paid any
attention to adding the 't' comments when I added tables to pages, and
I do recall anyone reporting ill effects. So, I'm inclined to apply
Mike's patch, but will hold off a moment, in case there's other
feedback.

Cheers,

Michael

-- 
Michael Kerrisk
Linux man-pages maintainer; http://www.kernel.org/doc/man-pages/
Linux/UNIX System Programming Training: http://man7.org/training/

  reply index

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-07-23 21:53 Mike Frysinger
2020-07-24  0:03 ` G. Branden Robinson
2020-07-24 10:13   ` Michael Kerrisk (man-pages) [this message]
2020-07-24 12:15     ` G. Branden Robinson
2020-07-24 12:30       ` Michael Kerrisk (man-pages)
2020-07-24 13:13         ` Stefan Puiu
2020-07-24 15:17           ` Michael Kerrisk (man-pages)

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='CAKgNAkjwwxrM_ry-b1rtrVc8YjfNE=p4iAht85P+mBs6Eq0U-w@mail.gmail.com' \
    --to=mtk.manpages@gmail.com \
    --cc=g.branden.robinson@gmail.com \
    --cc=linux-man@vger.kernel.org \
    /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

Linux-man Archive on lore.kernel.org

Archives are clonable:
	git clone --mirror https://lore.kernel.org/linux-man/0 linux-man/git/0.git

	# If you have public-inbox 1.1+ installed, you may
	# initialize and index your mirror using the following commands:
	public-inbox-init -V2 linux-man linux-man/ https://lore.kernel.org/linux-man \
		linux-man@vger.kernel.org
	public-inbox-index linux-man

Example config snippet for mirrors

Newsgroup available over NNTP:
	nntp://nntp.lore.kernel.org/org.kernel.vger.linux-man


AGPL code for this site: git clone https://public-inbox.org/public-inbox.git