Re: [Tinycc-devel] tinycc manpage

[Michael Matz]

Hello,

On Fri, 25 Dec 2020, Sudipto Mallick wrote:

> When I compiled a recent version of tinycc from mob, I looked at the
> source of the manpage. I don't like it.

In which sense?  tcc.1 is a generated file, it's not supposed to be 
edited.  The source is tcc-doc.texi, i.e. texinfo, via texi2pod and 
pod2man.  So, are you sure you're barking at the right tree?

> I learnt about the mdoc(7) format for writing man pages and thought to 
> use that format for the tcc man page. The rewrite is attached.

While -mdoc certainly is nicer than -man it's both trumped (IMHO) by 
perlpod and texinfo, in writability.

> What do you think about this mdoc formatted manual page?

I think it's nicer than the current generated tcc.1 file, and I think it's 
somewhat more purist to directly write mdoc files for a project like TCC, 
instead of generating them.  But I also think that something like this 
needs to be easy to write/edit, and in this case I'd argue that texinfo is 
just fine.

> This is not yet complete (see TODOs). Please give suggestion to complete 
> it.


Ciao,
Michael.