Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 20 May 2019 20:20:51 +1000 (EST)
From:      Bruce Evans <brde@optusnet.com.au>
To:        Warner Losh <imp@bsdimp.com>
Cc:        Yoshihiro Ota <ota@j.email.ne.jp>,  "Rodney W. Grimes" <rgrimes@freebsd.org>,  "Rodney W. Grimes" <freebsd@gndrsh.dnsmgr.net>,  Benedict Reuschling <bcr@freebsd.org>,  src-committers <src-committers@freebsd.org>, svn-src-stable@freebsd.org,  svn-src-all <svn-src-all@freebsd.org>, svn-src-stable-12@freebsd.org,  Bruce Evans <brde@optusnet.com.au>,  Konstantin Belousov <kostikbel@gmail.com>
Subject:   Re: svn commit: r347951 - stable/12/lib/libc/stdlib
Message-ID:  <20190520201507.R1014@besplex.bde.org>
In-Reply-To: <CANCZdfofhf9BH%2B7Yx1tnbBP_k9yvUjb32MvqcM-e7DjX0kHXNA@mail.gmail.com>
References:  <a10ebbe0-120d-a0e3-ef85-74c7c1267170@FreeBSD.org> <201905181306.x4ID6piX064982@gndrsh.dnsmgr.net> <20190519115456.40571481c85c9f178657d6b9@j.email.ne.jp> <CANCZdfofhf9BH%2B7Yx1tnbBP_k9yvUjb32MvqcM-e7DjX0kHXNA@mail.gmail.com>

next in thread | previous in thread | raw e-mail | index | archive | help
On Sun, 19 May 2019, Warner Losh wrote:

> On Sun, May 19, 2019 at 9:56 AM Yoshihiro Ota <ota@j.email.ne.jp> wrote:
>
>> I wonder if we can use a tool to confirm coding style like
>> clang-format or something else.
>
> I don't know... it might be hard to do that inside a man page...

Examples in man pages need special treatment since man adds a 5 column
left margin and then must mangle tabs to preserve 8-column indentation.
The examples must at least be formatted for width 74 instead of 79, but
74 is better anyway.

I had some success turning SYNOPSIS sections into C code for checking
that the headers are complete and the documented prototypes agree with
the headers.  Large examples would probably have to be extracted manually
since they are less structured than SYNOPSIS sections.

Bruce



Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20190520201507.R1014>