Re: [PATCH v1] man/man2/adjtimex.2: Add include, macro and error for clock_adjtime

[Georg Sauthoff <mail@gms.tf>]

Hello,

On Sun, Oct 25, 2026 at 07:49:32PM +0100, Alejandro Colomar wrote:
> Hi Georg,
> 
> > Date: 2026-10-25 13:56:56+0100
> > From: Georg Sauthoff <mail@gms.tf>
> > Subject: [PATCH v1] man/man2/adjtimex.2: Add include, macro and error for clock_adjtime
> 
> Please separate this into two patches, each of which does only one
> thing.  The error seems unrelated to the include.

Ok. Yes, it's unrelated. It wasn't my intention to imply that both hunks
are related.

I'll split it and send both as version 2.


> > diff --git a/man/man2/adjtimex.2 b/man/man2/adjtimex.2
> > index f12d9413e..528fd3a6f 100644
> > --- a/man/man2/adjtimex.2
> > +++ b/man/man2/adjtimex.2
> > @@ -17,9 +17,21 @@ .SH SYNOPSIS
> >  .P
> >  .BI "int adjtimex(struct timex *" "buf" );
> >  .P
> > -.BI "int clock_adjtime(clockid_t " clk_id, " struct timex *" "buf" );
> > -.P
> >  .BI "int ntp_adjtime(struct timex *" buf );
> > +.P
> > +.BR #include <time.h>
> 
> BR is for alternating bold and roman, so this seems wrong.  You probably
> want just B (see the include above).

FWIW, I copy and pasted the BR from another man page I picked as
template which already references _GNU_SOURCE, cf.

    $ grep '^\.BR #include' . -r | wc -l
    23

Ok, I change it to B. Also for consistency.


> BTW, I would use
> 
> 	.B #define _GNU_SOURCE
> 	.B #include <time.h>
> 
> and then remove the Feature Test Macro text below.

Ok, no problem. Again, I just copied that style from another man page:

    $ grep '^\.BR feature_test_macros' . -r -A50 | grep '\<_GNU' | wc -l
    62

The define style seems to be more popular, though:

    $ grep '#define _GNU_SOURCE' . -r | wc -l
    153

Plus special space variant:

    $ grep '#define\\~_GNU_SOURCE' . -r | wc -l
    2

I don't really have a preference between these styles and thus follow
your suggestion.

Best regards,
Georg