Hi Martin, hi Klemens,

Martin Pieuchot wrote on Wed, Mar 18, 2020 at 09:06:24PM +0100:
> On 18/03/20(Wed) 20:45, Klemens Nanni wrote:

>> It takes a format string, e.g.
>> 
>>      syscall:sysctl:entry {
>>              time("%+\n")
>>      }

I can't comment on the content of bt(5).

> This is indeed an improvement, thanks!  I don't know how to point that
> 'format' or 'timefmt' is the same as describe in strftime(3).

One way to do that might be similar to this:

  .It Fn time format
  print timestamps using
  .Xr strftime 3
  with the
  .Fa format
  argument

the point being that the placeholder "format" is the same one as
the one used in the SYNOPSIS of the strftime(3) page (if i understand
correctly what is going on here).

Your call how exactly you want to do it.

> Does that mean strftime(3) should appear in SEE ALSO?

As a rough rule of thumb (not a strict prescription), put an .Xr
into the text when the reference helps understanding of that specific
point in the text, and put an .Xr into SEE ALSO when the reference
helps understanding of the page as a whole.

So here, a reference below SEE ALSO might not be needed, and Klemens
already included one in the text.

> So unless any man guru jump in, to improve the submission, just go ahead
> with my ok :o) 

Certainly no objection either way.

Yours,
  Ingo

>> Index: bt.5
>> ===================================================================
>> RCS file: /cvs/src/usr.sbin/btrace/bt.5,v
>> retrieving revision 1.2
>> diff -u -p -r1.2 bt.5
>> --- bt.5     27 Jan 2020 14:15:25 -0000      1.2
>> +++ bt.5     18 Mar 2020 19:42:16 -0000
>> @@ -117,8 +117,9 @@ Print all (key, value) pairs from map
>>  .It Fn printf "fmt" ...
>>  print formatted string
>>  .Va fmt
>> -.It Fn time
>> -print formatted time
>> +.It Fn time timefmt
>> +print timestamps using
>> +.Xr strftime 3
>>  .El
>>  .Sh SEE ALSO
>>  .Xr awk 1 ,
>> 

Reply via email to